{"resource_docs":[{"operation_id":"OBPv1.2.1-getImagesForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getImagesForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","summary":"Get Transaction Images","description":"
Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nlabel: My Account
\nprovider: ETHEREUM
\nuser:
\n","description_markdown":"Returns the transaction TRANSACTION_ID images made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n Authentication via OAuth is required if the view is not public.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**images**](/glossary#images): \n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"images":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}]},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"images":{"type":"array","items":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteTagForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags/TAG_ID","summary":"Delete a Transaction Tag","description":"Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account,
\nor must be the user that posted the tag.
Authentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\nAuthentication via OAuth is required. The user must either have owner privileges for this account, \nor must be the user that posted the tag.\n\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TAG_ID](/glossary#tag_id): \n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags/TAG_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBalancingTransaction","implemented_by":{"version":"OBPv4.0.0","function":"getBalancingTransaction"},"request_verb":"GET","request_url":"/obp/v4.0.0/transactions/TRANSACTION_ID/balancing-transaction","summary":"Get Balancing Transaction","description":"Get Balancing Transaction
\nAuthentication is Mandatory
\nURL Parameters:
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncredit_transaction: credit_transaction
\ndebit_transaction: debit_transaction
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request: transaction_request
\ntransaction_request_id: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\n","description_markdown":"Get Balancing Transaction\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**credit_transaction**](/glossary#): credit_transaction\n\n\n\n[**debit_transaction**](/glossary#): debit_transaction\n\n\n\n[**transaction_id**](/glossary#): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[**transaction_request**](/glossary#): transaction_request\n\n\n\n[**transaction_request_id**](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n","success_response_body":{"transaction_request":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","transaction_request_id":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1"},"debit_transaction":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"},"credit_transaction":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Transaction"],"typed_success_response_body":{"type":"object","properties":{"debit_transaction":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_id":{"type":"string"},"account_id":{"type":"string"}}},"credit_transaction":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_id":{"type":"string"},"account_id":{"type":"string"}}},"transaction_request":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_request_id":{"type":"string"},"account_id":{"type":"string"}}}}},"roles":[],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/transactions/TRANSACTION_ID/balancing-transaction","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateTransactionAttribute","implemented_by":{"version":"OBPv4.0.0","function":"updateTransactionAttribute"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attributes/ACCOUNT_ATTRIBUTE_ID","summary":"Update Transaction Attribute","description":"Update Transaction Attribute
\nAuthentication is Mandatory
\nURL Parameters:
\n\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","description_markdown":"Update Transaction Attribute\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ATTRIBUTE_ID](/glossary#account_attribute_id): \n\n\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"success_response_body":{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"error_response_bodies":["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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanUpdateTransactionAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attributes/ACCOUNT_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-getTransactionByIdForBankAccount","implemented_by":{"version":"OBPv3.1.0","function":"getTransactionByIdForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/transaction","summary":"Get Transaction by Id","description":"Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_ID).
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\n\namount: 10.12
\n\n\ncompleted: 2020-01-27
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nnew_balance: 20
\n\n\n\nposted: 2020-01-27
\n\nprovider: ETHEREUM
\n\nscheme: scheme value
\ntags: Create-My-User
\n\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ntype:
\nuser:
\nvalue: 5987953
\n\n","description_markdown":"Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and [moderated](#1_2_1-getViewsForBankAccount) by the view (VIEW_ID).\n\nAuthentication is Optional\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**holders**](/glossary#holders): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**images**](/glossary#images): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**other_account**](/glossary#other_account): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**transaction_attributes**](/glossary#transaction_attributes): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**where**](/glossary#where): \n\n\n","success_response_body":{"id":"String","this_account":{"id":"String","bank_routing":{"scheme":"scheme value","address":""},"account_routings":[{"scheme":"AccountNumber","address":"4930396"}],"holders":[{"name":"OBP","is_alias":true}]},"other_account":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"bank_routing":{"scheme":"scheme value","address":""},"account_routings":[{"scheme":"AccountNumber","address":"4930396"}],"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"}}}},"details":{"type":"AC","description":"this is for family","posted":"1100-01-01T00:00:00Z","completed":"1100-01-01T00:00:00Z","new_balance":{"currency":"EUR","amount":"0"},"value":{"currency":"EUR","amount":"0"}},"metadata":{"narrative":"NONE","comments":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"tags":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"images":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"where":{"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"}}},"transaction_attributes":[{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"}]},"error_response_bodies":["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-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Transaction"],"typed_success_response_body":{"type":"object","properties":{"metadata":{"type":"object","properties":{"narrative":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"images":{"type":"array","items":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}},"where":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}},"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"posted":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"completed":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"other_account":{"type":"object","properties":{"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}}},"this_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/transaction","connector_methods":[]},{"operation_id":"OBPv4.0.0-getTransactionAttributeById","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionAttributeById"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attributes/ATTRIBUTE_ID","summary":"Get Transaction Attribute By Id","description":"Get Transaction Attribute By Id
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Transaction Attribute By Id\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[ATTRIBUTE_ID](/glossary#Adapter.card_attribute_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"error_response_bodies":["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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_success_response_body":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanGetTransactionAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attributes/ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-getTagsForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getTagsForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","summary":"Get Transaction Tags","description":"Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
Authentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Returns the transaction TRANSACTION_ID tags made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n Authentication via OAuth is required if the view is not public.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCommentForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteCommentForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments/COMMENT_ID","summary":"Delete a Transaction Comment","description":"Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COMMENT_ID](/glossary#comment_id): \n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments/COMMENT_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCommentForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addCommentForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","summary":"Add a Transaction Comment","description":"Posts a comment about a transaction TRANSACTION_ID on a view VIEW_ID.
\n${authenticationRequiredMessage(false)}
\nAuthentication is required since the comment is linked with the user.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nvalue: 5987953
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Posts a comment about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\n${authenticationRequiredMessage(false)}\n\nAuthentication is required since the comment is linked with the user.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"value":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","connector_methods":[]},{"operation_id":"OBPv1.2.1-addImageForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addImageForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","summary":"Add a Transaction Image","description":"Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID.
\nAuthentication is Mandatory
\nThe image is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\nlabel: My Account
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\nprovider: ETHEREUM
\nuser:
\n","description_markdown":"Posts an image about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\nAuthentication is Mandatory\n\nThe image is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n","example_request_body":{"label":"String","URL":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"error_response_bodies":["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!"],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"URL":{"type":"string"},"label":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionAttribute","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionAttribute"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attribute","summary":"Create Transaction Attribute","description":"Create Transaction Attribute
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","description_markdown":"Create Transaction Attribute\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"success_response_body":{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"error_response_bodies":["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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanCreateTransactionAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attribute","connector_methods":[]},{"operation_id":"OBPv1.2.1-getWhereTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getWhereTagForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","summary":"Get a Transaction where Tag","description":"Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID).
\nIt represents the location where the transaction has been initiated.
Authentication via OAuth is required if the view is not public.
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\nlongitude: -77.0364
\nprovider: ETHEREUM
\nuser:
\n\n","description_markdown":"Returns the \"where\" Geo tag added to the transaction TRANSACTION_ID made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\nIt represents the location where the transaction has been initiated.\n\nAuthentication via OAuth is required if the view is not public.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**where**](/glossary#where): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"where":{"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"}}},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":[]},{"operation_id":"OBPv4.0.0-getTransactionAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionAttributeDefinition"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/transaction","summary":"Get Transaction Attribute Definition","description":"Get Transaction Attribute Definition
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: true
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_active: true
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Get Transaction Attribute Definition\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**attributes**](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): true\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"attributes":[{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Transaction","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_success_response_body":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}},"roles":[{"role":"CanGetTransactionAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/attribute-definitions/transaction","connector_methods":[]},{"operation_id":"OBPv1.2.1-getCommentsForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getCommentsForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","summary":"Get Transaction Comments","description":"Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Returns the transaction TRANSACTION_ID comments made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n\nAuthentication via OAuth is required if the view is not public.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"comments":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}]},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","connector_methods":[]},{"operation_id":"OBPv4.0.0-getTransactionAttributes","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionAttributes"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attributes","summary":"Get Transaction Attributes","description":"Get Transaction Attributes
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Transaction Attributes\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**transaction_attributes**](/glossary#transaction_attributes): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"transaction_attributes":[{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"}]},"error_response_bodies":["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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_success_response_body":{"type":"object","properties":{"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}}},"roles":[{"role":"CanGetTransactionAttributesAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attributes","connector_methods":[]},{"operation_id":"OBPv1.2.1-getTransactionNarrative","implemented_by":{"version":"OBPv1.2.1","function":"getTransactionNarrative"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","summary":"Get a Transaction Narrative","description":"Returns the account owner description of the transaction moderated by the view.
\nAuthentication via OAuth is required if the view is not public.
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Returns the account owner description of the transaction [moderated](#1_2_1-getViewsForBankAccount) by the view.\n\nAuthentication via OAuth is required if the view is not public.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"narrative":"narative"},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"narrative":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":[]},{"operation_id":"OBPv1.2.1-addWhereTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addWhereTagForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","summary":"Add a Transaction where Tag","description":"Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view.
\nAuthentication is Mandatory
\nThe geo tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nJSON response body fields:
\n\n","description_markdown":"Creates a \"where\" Geo tag on a transaction TRANSACTION_ID in a [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication is Mandatory\n\nThe geo tag is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**where**](/glossary#where): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"where":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":[]},{"operation_id":"OBPv3.0.0-getTransactionsForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getTransactionsForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions","summary":"Get Transactions for Account (Full)","description":"Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\n\namount: 10.12
\n\n\ncompleted: 2020-01-27
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nnew_balance: 20
\n\n\n\nposted: 2020-01-27
\n\nprovider: ETHEREUM
\n\nscheme: scheme value
\ntags: Create-My-User
\n\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ntype:
\nuser:
\nvalue: 5987953
\n\n","description_markdown":"Returns transactions list of the account specified by ACCOUNT_ID and [moderated](#1_2_1-getViewsForBankAccount) by the view (VIEW_ID).\n\nAuthentication is Optional\n\nAuthentication is required if the view is not public.\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 500\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n\n* from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).\n* to_date=DATE => example value: 2024-02-27T14:01:48.252Z. NOTE! The default value is now (2024-02-27T14:01:48.252Z).\n\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.\n\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**holders**](/glossary#holders): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**images**](/glossary#images): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**other_account**](/glossary#other_account): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**transaction_attributes**](/glossary#transaction_attributes): \n\n\n\n[**transactions**](/glossary#transactions): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**where**](/glossary#where): \n\n\n","success_response_body":{"transactions":[{"id":"String","this_account":{"id":"String","bank_routing":{"scheme":"scheme value","address":""},"account_routings":[{"scheme":"AccountNumber","address":"4930396"}],"holders":[{"name":"OBP","is_alias":true}]},"other_account":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"bank_routing":{"scheme":"scheme value","address":""},"account_routings":[{"scheme":"AccountNumber","address":"4930396"}],"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"}}}},"details":{"type":"AC","description":"this is for family","posted":"1100-01-01T00:00:00Z","completed":"1100-01-01T00:00:00Z","new_balance":{"currency":"EUR","amount":"0"},"value":{"currency":"EUR","amount":"0"}},"metadata":{"narrative":"NONE","comments":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"tags":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"images":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"where":{"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"}}},"transaction_attributes":[{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"}]}]},"error_response_bodies":["OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!","OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!","OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!","OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!","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-50000: Unknown Error."],"tags":["Transaction","Account"],"typed_success_response_body":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"metadata":{"type":"object","properties":{"narrative":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"images":{"type":"array","items":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}},"where":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}},"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"posted":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"completed":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"other_account":{"type":"object","properties":{"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}}},"this_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}}},"id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions","connector_methods":[]},{"operation_id":"OBPv4.0.0-createOrUpdateTransactionAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"createOrUpdateTransactionAttributeDefinition"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/transaction","summary":"Create or Update Transaction Attribute Definition","description":"Create or Update Transaction Attribute Definition
\nThe category field must be Transaction
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: true
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_active: true
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Create or Update Transaction Attribute Definition\n\nThe category field must be Transaction\n\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): true\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"name":"SPECIAL_TAX_NUMBER","category":"Transaction","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"success_response_body":{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Transaction","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_request_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"roles":[{"role":"CanCreateTransactionAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/attribute-definitions/transaction","connector_methods":[]},{"operation_id":"OBPv3.0.0-getFirehoseTransactionsForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getFirehoseTransactionsForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/firehose/accounts/ACCOUNT_ID/views/VIEW_ID/transactions","summary":"Get Firehose Transactions for Account","description":"Get Transactions for an Account that has a firehose View.
\nAllows bulk access to an account's transactions.
\nUser must have the CanUseFirehoseAtAnyBank Role
To find ACCOUNT_IDs, use the getFirehoseAccountsAtOneBank call.
\nFor VIEW_ID try 'owner'
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\n\namount: 10.12
\n\n\ncompleted: 2020-01-27
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nnew_balance: 20
\n\n\n\nposted: 2020-01-27
\n\nprovider: ETHEREUM
\n\nscheme: scheme value
\ntags: Create-My-User
\n\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ntype:
\nuser:
\nvalue: 5987953
\n\n","description_markdown":"Get Transactions for an Account that has a firehose View.\n\nAllows bulk access to an account's transactions.\nUser must have the CanUseFirehoseAtAnyBank Role\n\nTo find ACCOUNT_IDs, use the getFirehoseAccountsAtOneBank call.\n\nFor VIEW_ID try 'owner'\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 500\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n\n* from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).\n* to_date=DATE => example value: 2024-02-27T14:01:48.251Z. NOTE! The default value is now (2024-02-27T14:01:48.251Z).\n\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.\n\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**holders**](/glossary#holders): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**images**](/glossary#images): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**other_account**](/glossary#other_account): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**transaction_attributes**](/glossary#transaction_attributes): \n\n\n\n[**transactions**](/glossary#transactions): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**where**](/glossary#where): \n\n\n","success_response_body":{"transactions":[{"id":"String","this_account":{"id":"String","bank_routing":{"scheme":"scheme value","address":""},"account_routings":[{"scheme":"AccountNumber","address":"4930396"}],"holders":[{"name":"OBP","is_alias":true}]},"other_account":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"bank_routing":{"scheme":"scheme value","address":""},"account_routings":[{"scheme":"AccountNumber","address":"4930396"}],"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"}}}},"details":{"type":"AC","description":"this is for family","posted":"1100-01-01T00:00:00Z","completed":"1100-01-01T00:00:00Z","new_balance":{"currency":"EUR","amount":"0"},"value":{"currency":"EUR","amount":"0"}},"metadata":{"narrative":"NONE","comments":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"tags":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"images":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"where":{"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"}}},"transaction_attributes":[{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-00009: Account firehose is not allowed on this instance. Please set allow_account_firehose = true in props files. ","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Transaction","Account-Firehose","Transaction-Firehose","FirehoseData"],"typed_success_response_body":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"metadata":{"type":"object","properties":{"narrative":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"images":{"type":"array","items":{"type":"object","properties":{"URL":{"type":"string"},"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}},"where":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}},"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"posted":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"completed":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"other_account":{"type":"object","properties":{"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}}},"this_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}}},"id":{"type":"string"}}}}}},"roles":[{"role":"CanUseAccountFirehoseAtAnyBank","requires_bank_id":false},{"role":"CanUseAccountFirehose","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/firehose/accounts/ACCOUNT_ID/views/VIEW_ID/transactions","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateWhereTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"updateWhereTagForViewOnTransaction"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","summary":"Update a Transaction where Tag","description":"Updates the "where" Geo tag on a transaction TRANSACTION_ID in a view.
\nAuthentication is Mandatory
\nThe geo tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Updates the \"where\" Geo tag on a transaction TRANSACTION_ID in a [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication is Mandatory\n\nThe geo tag is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"where":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateTransactionNarrative","implemented_by":{"version":"OBPv1.2.1","function":"updateTransactionNarrative"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","summary":"Update a Transaction Narrative","description":"Updates the description of the transaction TRANSACTION_ID.
\nAuthentication via OAuth is required if the view is not public.
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Updates the description of the transaction TRANSACTION_ID.\n\nAuthentication via OAuth is required if the view is not public.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"narrative":"narative"},"success_response_body":{"success":"Success"},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"narrative":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":[]},{"operation_id":"OBPv3.0.0-getCoreTransactionsForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getCoreTransactionsForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/my/banks/BANK_ID/accounts/ACCOUNT_ID/transactions","summary":"Get Transactions for Account (Core)","description":"Returns transactions list (Core info) of the account specified by ACCOUNT_ID.
\nAuthentication is Mandatory
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\namount: 10.12
\n\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nnew_balance: 20
\n\nposted: 2020-01-27
\nscheme: scheme value
\n\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ntype:
\nvalue: 5987953
\n","description_markdown":"Returns transactions list (Core info) of the account specified by ACCOUNT_ID.\n\nAuthentication is Mandatory\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 500\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n\n* from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).\n* to_date=DATE => example value: 2024-02-27T14:01:48.251Z. NOTE! The default value is now (2024-02-27T14:01:48.251Z).\n\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.\n\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**holders**](/glossary#holders): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**other_account**](/glossary#other_account): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**transaction_attributes**](/glossary#transaction_attributes): \n\n\n\n[**transactions**](/glossary#transactions): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"transactions":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","this_account":{"id":"String","bank_routing":{"scheme":"scheme value","address":""},"account_routings":[{"scheme":"AccountNumber","address":"4930396"}],"holders":[{"name":"OBP","is_alias":true}]},"other_account":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"bank_routing":{"scheme":"scheme value","address":""},"account_routings":[{"scheme":"AccountNumber","address":"4930396"}]},"details":{"type":"AC","description":"OBP","posted":"1100-01-01T00:00:00Z","completed":"1100-01-01T00:00:00Z","new_balance":{"currency":"EUR","amount":"0"},"value":{"currency":"EUR","amount":"0"}},"transaction_attributes":[{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"}]}]},"error_response_bodies":["OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!","OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!","OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!","OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!","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-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction","Account Information Service (AIS)","Account","PSD2"],"typed_success_response_body":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"posted":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"completed":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"other_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}}},"id":{"type":"string"},"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"this_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/my/banks/BANK_ID/accounts/ACCOUNT_ID/transactions","connector_methods":[]},{"operation_id":"OBPv1.2.1-getOtherAccountForTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getOtherAccountForTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/other_account","summary":"Get Other Account of Transaction","description":"Get other account of a transaction.
\nReturns details of the other party involved in the transaction, moderated by the view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
Authentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\nURL: http://www.example.com/id-docs/123/image.png
\nbank:
\n\ndate: 2020-01-27
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nkind:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\n\nprovider: ETHEREUM
\n\n\nuser:
\n","description_markdown":"Get other account of a transaction.\nReturns details of the other party involved in the transaction, moderated by the [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n Authentication via OAuth is required if the view is not public.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**IBAN**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**bank**](/glossary#Bank): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**kind**](/glossary#kind): \n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**national_identifier**](/glossary#national_identifier): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**swift_bic**](/glossary#swift_bic): \n\n\n\n[**user**](/glossary#User): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"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"}}}},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["Transaction","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"type":"string"},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"IBAN":{"type":"string"},"swift_bic":{"type":"string"},"number":{"type":"string"},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"bank":{"type":"object","properties":{"national_identifier":{"type":"string"},"name":{"type":"string"}}},"kind":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/other_account","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteWhereTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteWhereTagForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","summary":"Delete a Transaction Tag","description":"Deletes the where tag of the transaction TRANSACTION_ID made on view.
\nAuthentication is Mandatory
\nThe user must either have owner privileges for this account, or must be the user that posted the geo tag.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the where tag of the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication is Mandatory\n\nThe user must either have owner privileges for this account, or must be the user that posted the geo tag.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteTransactionCascade","implemented_by":{"version":"OBPv4.0.0","function":"deleteTransactionCascade"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/cascading/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID","summary":"Delete Transaction Cascade","description":"Delete a Transaction Cascade specified by TRANSACTION_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\n","description_markdown":"Delete a Transaction Cascade specified by TRANSACTION_ID.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["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-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Transaction"],"roles":[{"role":"CanDeleteTransactionCascade","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/management/cascading/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteTransactionAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"deleteTransactionAttributeDefinition"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/transaction","summary":"Delete Transaction Attribute Definition","description":"Delete Transaction Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nAuthentication is Mandatory
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete Transaction Attribute Definition by ATTRIBUTE_DEFINITION_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ATTRIBUTE_DEFINITION_ID](/glossary#attribute_definition_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"roles":[{"role":"CanDeleteTransactionAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/transaction","connector_methods":[]},{"operation_id":"OBPv1.2.1-addTransactionNarrative","implemented_by":{"version":"OBPv1.2.1","function":"addTransactionNarrative"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","summary":"Add a Transaction Narrative","description":"Creates a description of the transaction TRANSACTION_ID.
\nNote: Unlike other items of metadata, there is only one "narrative" per transaction accross all views.
\nIf 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
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Creates a description of the transaction TRANSACTION_ID.\n\nNote: Unlike other items of metadata, there is only one \"narrative\" per transaction accross all views.\nIf 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).\n\nAuthentication is Optional\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"narrative":"narative"},"success_response_body":{"success":"Success"},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"narrative":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteTransactionNarrative","implemented_by":{"version":"OBPv1.2.1","function":"deleteTransactionNarrative"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","summary":"Delete a Transaction Narrative","description":"Deletes the description of the transaction TRANSACTION_ID.
\nAuthentication via OAuth is required if the view is not public.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the description of the transaction TRANSACTION_ID.\n\nAuthentication via OAuth is required if the view is not public.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":[]},{"operation_id":"OBPv4.0.0-getDoubleEntryTransaction","implemented_by":{"version":"OBPv4.0.0","function":"getDoubleEntryTransaction"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/double-entry-transaction","summary":"Get Double Entry Transaction","description":"Get Double Entry Transaction
\nThis endpoint can be used to see the double entry transactions. It returns the bank_id
, account_id
and transaction_id
\nfor the debit end the credit transaction. The other side account can be a settlement account or an OBP account.
The endpoint also provide the transaction_request
object which contains the bank_id
, account_id
and
\ntransaction_request_id
of the transaction request at the origin of the transaction. Please note that if none
\ntransaction request is at the origin of the transaction, the transaction_request
object will be null
.
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncredit_transaction: credit_transaction
\ndebit_transaction: debit_transaction
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request: transaction_request
\ntransaction_request_id: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\n","description_markdown":"Get Double Entry Transaction\n\nThis endpoint can be used to see the double entry transactions. It returns the `bank_id`, `account_id` and `transaction_id`\nfor the debit end the credit transaction. The other side account can be a settlement account or an OBP account.\n\nThe endpoint also provide the `transaction_request` object which contains the `bank_id`, `account_id` and\n`transaction_request_id` of the transaction request at the origin of the transaction. Please note that if none\ntransaction request is at the origin of the transaction, the `transaction_request` object will be `null`.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**credit_transaction**](/glossary#): credit_transaction\n\n\n\n[**debit_transaction**](/glossary#): debit_transaction\n\n\n\n[**transaction_id**](/glossary#): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[**transaction_request**](/glossary#): transaction_request\n\n\n\n[**transaction_request_id**](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n","success_response_body":{"transaction_request":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","transaction_request_id":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1"},"debit_transaction":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"},"credit_transaction":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"}},"error_response_bodies":["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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_success_response_body":{"type":"object","properties":{"debit_transaction":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_id":{"type":"string"},"account_id":{"type":"string"}}},"credit_transaction":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_id":{"type":"string"},"account_id":{"type":"string"}}},"transaction_request":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_request_id":{"type":"string"},"account_id":{"type":"string"}}}}},"roles":[{"role":"CanGetDoubleEntryTransactionAtAnyBank","requires_bank_id":false},{"role":"CanGetDoubleEntryTransactionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/double-entry-transaction","connector_methods":[]},{"operation_id":"OBPv1.2.1-addTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addTagForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","summary":"Add a Transaction Tag","description":"Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID.
\nAuthentication is Mandatory
\nAuthentication is required as the tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nvalue: 5987953
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Posts a tag about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\nAuthentication is Mandatory\n\nAuthentication is required as the tag is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"value":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1100-01-01T00:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"},"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteImageForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteImageForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images/IMAGE_ID","summary":"Delete a Transaction Image","description":"Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[IMAGE_ID](/glossary#image_id): \n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["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."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images/IMAGE_ID","connector_methods":[]}]}