-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- Get Fast Firehose Accounts at Bank
- Get Firehose Accounts at Bank
-
-
Transaction
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- Get Firehose Transactions for Account
-
v5.1.0 filtered by tag: Account-Firehose (3 APIs)
Get Fast Firehose Accounts at Bank
This endpoint allows bulk access to accounts.
optional pagination parameters for filter with accounts
Possible custom url parameters for pagination:
- limit=NUMBER ==> default value: 50
- offset=NUMBER ==> default value: 0
eg1:?limit=100&offset=0
- sort_direction=ASC/DESC ==> default value: DESC.
eg2:?limit=100&offset=0&sort_direction=ASC
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
amount: 10.12
balance: 10
bank_id: gh.29.uk
code: 125
currency: EUR
id: d8839721-ad8f-45dd-9f78-2080414b93f9
label: My Account
product_code: 1234BW
provider: ETHEREUM
type:
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
user_name: felixsmith
value: 5987953
{
"accounts":[{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"bank_id":"gh.29.uk",
"label":"My Account",
"number":"",
"owners":[{
"user_id":"b27327a2-a822-41e5-a909-0150da688939",
"provider":"https://finx22openplatform.fintech-galaxy.com,user_name:synth_user_1_54891",
"user_name":""
}],
"product_code":"1234BW",
"balance":{
"currency":"EUR",
"amount":"0"
},
"account_routings":[{
"bank_id":"bisb.com",
"account_id":"c590e38e-847c-466f-9a62-f2ad67daf106"
}],
"account_attributes":[{
"type":"INTEGER",
"code":"Loan1",
"value":"0"
},{
"type":"STRING",
"code":"Loan1",
"value":"4421.783"
}]
}]
}
-
CanUseAccountFirehoseAtAnyBank
- Please login to request this Role
-
CanUseAccountFirehose
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
Get Firehose Accounts at Bank
Get Accounts which have a firehose view assigned to them.
This endpoint allows bulk access to accounts.
Requires the CanUseFirehoseAtAnyBank Role
To be shown on the list, each Account must have a firehose View linked to it.
A firehose view has is_firehose = true
For VIEW_ID try 'owner'
optional request parameters for filter with attributes
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?manager=John&count=8
to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be _timestamp_
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?manager=John&count=8&_timestamp_=1596762180358
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
amount: 10.12
balance: 10
bank_id: gh.29.uk
currency: EUR
id: d8839721-ad8f-45dd-9f78-2080414b93f9
label: My Account
product_code: 1234BW
provider: ETHEREUM
scheme: scheme value
value: 5987953
{
"accounts":[{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"bank_id":"gh.29.uk",
"label":"My Account",
"number":"",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}],
"product_code":"1234BW",
"balance":{
"currency":"EUR",
"amount":"0"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"account_rules":[{
"scheme":"OVERDRAFT",
"value":"10"
}]
}]
}
-
CanUseAccountFirehoseAtAnyBank
- Please login to request this Role
-
CanUseAccountFirehose
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
Get Firehose Transactions for Account
Get Transactions for an Account that has a firehose View.
Allows bulk access to an account's transactions.
User must have the CanUseFirehoseAtAnyBank Role
To find ACCOUNT_IDs, use the getFirehoseAccountsAtOneBank call.
For VIEW_ID try 'owner'
Possible custom url parameters for pagination:
- limit=NUMBER ==> default value: 50
- offset=NUMBER ==> default value: 0
eg1:?limit=100&offset=0
- sort_direction=ASC/DESC ==> default value: DESC.
eg2:?limit=100&offset=0&sort_direction=ASC
- 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).
- to_date=DATE => example value: 2024-09-07T00:00:37.177Z. NOTE! The default value is now (2024-09-07T00:00:37.177Z).
Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
Authentication is Mandatory
URL Parameters:
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner
JSON response body fields:
URL: http://www.example.com/id-docs/123/image.png
amount: 10.12
completed: 2020-01-27
currency: EUR
date: 2020-01-27
description: This an optional field. Maximum length is 2000. It can be any characters here.
id: d8839721-ad8f-45dd-9f78-2080414b93f9
label: My Account
latitude: 38.8951
longitude: -77.0364
more_info: More information about this fee
name: ACCOUNT_MANAGEMENT_FEE
new_balance: 20
posted: 2020-01-27
provider: ETHEREUM
scheme: scheme value
tags: Create-My-User
transaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
type:
user:
value: 5987953
{
"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"
}]
}]
}
-
CanUseAccountFirehoseAtAnyBank
- Please login to request this Role
-
CanUseAccountFirehose
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.