API Explorer

v4.0.0 (329 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Transaction Attribute

Create Transaction Attribute

The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"

Authentication is Mandatory

Typical Successful Response:

								
									
{ "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "name":"HOUSE_RENT", "type":"DATE_WITH_DAY", "value":"123456789" }
Required Roles:
  • CanCreateTransactionAttributeAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Implemented in OBPv4.0.0 by createTransactionAttribute

Create or Update Transaction Attribute Definition

Create or Update Transaction Attribute Definition

The category field must be Transaction

The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY

Authentication is Mandatory

Typical Successful Response:

								
									
{ "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 }
Required Roles:
  • CanCreateTransactionAttributeDefinitionAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Implemented in OBPv4.0.0 by createOrUpdateTransactionAttributeDefinition

Delete Transaction Attribute Definition

Delete Transaction Attribute Definition by ATTRIBUTE_DEFINITION_ID

Authentication is Mandatory

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteTransactionAttributeDefinitionAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Implemented in OBPv4.0.0 by deleteTransactionAttributeDefinition

Delete Transaction Cascade

Delete a Transaction Cascade specified by TRANSACTION_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteTransactionCascade - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv4.0.0 by deleteTransactionCascade

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 headers for pagination:

  • sort_direction=ASC/DESC ==> default value: DESC. The sort field is the completed date.
  • limit=NUMBER ==> default value: 50
  • offset=NUMBER ==> default value: 0
  • from_date=DATE => default value: 0000-00-00T00:00:00.000Z
  • to_date=DATE => default value: 3049-01-01T00:00:00.000Z

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "transactions":[{ "id":"String", "this_account":{ "id":"String", "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "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":"Bank_ID", "address":"gh.29.uk" }, "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":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }, "physical_location":{ "latitude":1.231, "longitude":1.231, "date":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } } } }, "details":{ "type":"AC", "description":"this is for family", "posted":"2017-09-19T00:00:00Z", "completed":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } } } }] }
Required Roles:
  • CanUseAccountFirehoseAtAnyBank - Please login to request this Role
Possible Errors:
  • 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.
Implemented in OBPv3.0.0 by getFirehoseTransactionsForBankAccount

Get Other Account of Transaction

Get other account of a transaction.
Returns details of the other party involved in the transaction, moderated by the view (VIEW_ID).
Authentication via OAuth is required if the view is not public.

Authentication is Optional

Typical Successful Response:

								
									
{ "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":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }, "physical_location":{ "latitude":1.231, "longitude":1.231, "date":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } } } }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by getOtherAccountForTransaction

Get Transaction Attribute By Id

Get Transaction Attribute By Id

Authentication is Mandatory

Typical Successful Response:

								
									
{ "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "name":"HOUSE_RENT", "type":"DATE_WITH_DAY", "value":"123456789" }
Required Roles:
  • CanGetTransactionAttributeAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Implemented in OBPv4.0.0 by getTransactionAttributeById

Get Transaction Attribute Definition

Get Transaction Attribute Definition

Authentication is Mandatory

Typical Successful Response:

								
									
{ "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 }] }
Required Roles:
  • CanGetTransactionAttributeDefinitionAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Implemented in OBPv4.0.0 by getTransactionAttributeDefinition

Get Transaction Attributes

Get Transaction Attributes

Authentication is Mandatory

Typical Successful Response:

								
									
{ "transaction_attributes":[{ "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "name":"HOUSE_RENT", "type":"DATE_WITH_DAY", "value":"123456789" }] }
Required Roles:
  • CanGetTransactionAttributesAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Implemented in OBPv4.0.0 by getTransactionAttributes

Get Transaction by Id

Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_ID).

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

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "this_account":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holders":[{ "name":"OBP", "is_alias":true }], "number":"123", "kind":"AC", "IBAN":"UK1234AD", "swift_bic":"UK1234AD", "bank":{ "national_identifier":"OBP", "name":"OBP" } }, "other_account":{ "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":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }, "physical_location":{ "latitude":1.231, "longitude":1.231, "date":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } } } }, "details":{ "type":"AC", "description":"this is for family", "posted":"2017-09-19T00:00:00Z", "completed":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } } } }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-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.
Implemented in OBPv3.1.0 by getTransactionByIdForBankAccount

Get Transactions for Account (Core)

Returns transactions list (Core info) of the account specified by ACCOUNT_ID.

Authentication is Mandatory

Possible custom url parameters for pagination:

  • sort_direction=ASC/DESC ==> default value: DESC. The sort field is the completed date.
  • limit=NUMBER ==> default value: 50
  • offset=NUMBER ==> default value: 0
  • from_date=DATE => default value: 0000-00-00T00:00:00.000Z
  • to_date=DATE => default value: 3049-01-01T00:00:00.000Z

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.

Typical Successful Response:

								
									
{ "transactions":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "this_account":{ "id":"String", "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "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":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }] }, "details":{ "type":"AC", "description":"OBP", "posted":"2017-09-19T00:00:00Z", "completed":"2017-09-19T00:00:00Z", "new_balance":{ "currency":"EUR", "amount":"0" }, "value":{ "currency":"EUR", "amount":"0" } } }] }
Possible Errors:
  • 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.
Implemented in OBPv3.0.0 by getCoreTransactionsForBankAccount

Get Transactions for Account (Full)

Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).

Authentication is Optional

Authentication is required if the view is not public.

Possible custom headers for pagination:

  • sort_direction=ASC/DESC ==> default value: DESC. The sort field is the completed date.
  • limit=NUMBER ==> default value: 50
  • offset=NUMBER ==> default value: 0
  • from_date=DATE => default value: 0000-00-00T00:00:00.000Z
  • to_date=DATE => default value: 3049-01-01T00:00:00.000Z

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.

Typical Successful Response:

								
									
{ "transactions":[{ "id":"String", "this_account":{ "id":"String", "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "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":"Bank_ID", "address":"gh.29.uk" }, "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":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } }, "physical_location":{ "latitude":1.231, "longitude":1.231, "date":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } } } }, "details":{ "type":"AC", "description":"this is for family", "posted":"2017-09-19T00:00:00Z", "completed":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" } } } }] }
Possible Errors:
  • OBP-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.
Implemented in OBPv3.0.0 by getTransactionsForBankAccount

Update Transaction Attribute

Update Transaction Attribute

Authentication is Mandatory

Typical Successful Response:

								
									
{ "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "name":"HOUSE_RENT", "type":"DATE_WITH_DAY", "value":"123456789" }
Required Roles:
  • CanUpdateTransactionAttributeAtOneBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Implemented in OBPv4.0.0 by updateTransactionAttribute