{"resource_docs":[{"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":[]}]}