API Explorer

FSBT TECH APIs v3.0.0 tagged: Transaction, TransactionMetadata (21)

Bank

Accounts

Views

Counterparties

Transactions

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.

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":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }, "physical_location":{ "latitude":1.231, "longitude":1.231, "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "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.
Implmented in 1_2_1 by getOtherAccountForTransaction

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":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }, "physical_location":{ "latitude":1.231, "longitude":1.231, "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } } } }, "details":{ "type":"AC", "description":"GOOD", "posted":"2013-01-22T00:08:00Z", "completed":"2013-01-22T00:08:00Z", "new_balance":{ "currency":"EUR", "amount":"10" }, "value":{ "currency":"EUR", "amount":"10" } }, "metadata":{ "narrative":"NONE", "comments":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }], "tags":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }], "images":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"NONE", "url":"www.openbankproject.com", "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }], "where":{ "latitude":1.231, "longitude":1.231, "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "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.
Implmented in 1_2_1 by getTransactionByIdForBankAccount

Get Transactions for Account (Core)

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

Authentication is Mandatory

Possible custom headers for pagination:

  • obp_sort_direction=ASC/DESC ==> default value: DESC. The sort field is the completed date.
  • obp_limit=NUMBER ==> default value: 50
  • obp_offset=NUMBER ==> default value: 0
  • obp_from_date=DATE => default value: Thu Jan 01 01:00:00 CET 1970 (format below)
  • obp_to_date=DATE => default value: 3049-01-01

Date format parameter: "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" (2014-07-01T00:00:00.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_routing":{ "scheme":"IBAN", "address":"DE89 3704 0044 0532 0130 00" }, "holders":[{ "name":"OBP", "is_alias":true }] }, "other_account":{ "id":"String", "holder":{ "name":"OBP", "is_alias":true }, "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routing":{ "scheme":"IBAN", "address":"DE89 3704 0044 0532 0130 00" } }, "details":{ "type":"AC", "description":"OBP", "posted":"2013-01-22T00:08:00Z", "completed":"2013-01-22T00:08:00Z", "new_balance":{ "currency":"EUR", "amount":"10" }, "value":{ "currency":"EUR", "amount":"10" } } }] }
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' or that one yyyy-MM-dd'T'HH:mm:ss.SSSZ!
  • 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.
Implmented in 3_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:

  • obp_sort_direction=ASC/DESC ==> default value: DESC. The sort field is the completed date.
  • obp_limit=NUMBER ==> default value: 50
  • obp_offset=NUMBER ==> default value: 0
  • obp_from_date=DATE => default value: date of the oldest transaction registered (format below)
  • obp_to_date=DATE => default value: 3049-01-01

Date format parameter: "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" (2014-07-01T00:00:00.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_routing":{ "scheme":"IBAN", "address":"DE89 3704 0044 0532 0130 00" }, "holders":[{ "name":"OBP", "is_alias":true }] }, "other_account":{ "id":"String", "holder":{ "name":"OBP", "is_alias":true }, "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routing":{ "scheme":"IBAN", "address":"DE89 3704 0044 0532 0130 00" }, "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":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }, "physical_location":{ "latitude":1.231, "longitude":1.231, "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } } } }, "details":{ "type":"AC", "description":"GOOD", "posted":"2013-01-22T00:08:00Z", "completed":"2013-01-22T00:08:00Z", "new_balance":{ "currency":"EUR", "amount":"10" }, "value":{ "currency":"EUR", "amount":"10" } }, "metadata":{ "narrative":"NONE", "comments":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }], "tags":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }], "images":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"NONE", "url":"www.openbankproject.com", "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }], "where":{ "latitude":1.231, "longitude":1.231, "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "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' or that one yyyy-MM-dd'T'HH:mm:ss.SSSZ!
  • 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.
Implmented in 3_0_0 by getTransactionsForBankAccount

Add a tag.

Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID.

Authentication is Mandatory

Authentication is required as the tag is linked with the user.

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }
Possible Errors:
  • 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.
  • view owner does not authorize metadata access
  • view owner does not authorize adding tags
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by addTagForViewOnTransaction

Add an image.

Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID.

Authentication is Mandatory

The image is linked with the user.

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"NONE", "url":"www.openbankproject.com", "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • view does not authorize metadata access
  • view does not authorize adding images
  • Could not parse url string as a valid URL
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by addImageForViewOnTransaction

Add comment.

Posts a comment about a transaction TRANSACTION_ID on a view VIEW_ID.

${authenticationRequiredMessage(false)}

Authentication is required since the comment is linked with the user.

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }
Possible Errors:
  • 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.
  • view owner does not authorize metadata access
  • view owner does not authorize adding comments
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by addCommentForViewOnTransaction

Add narrative.

Creates a description of the transaction TRANSACTION_ID.

Note: Unlike other items of metadata, there is only one "narrative" per transaction accross all views. If you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative).

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

Typical Successful Response:

								
									
{ "success":"Success" }
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • view does not authorize metadata access
  • view does not authorize narrative access
  • view does not allow adding a narrative
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by addTransactionNarrative

Add where tag.

Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view.

Authentication is Mandatory

The geo tag is linked with the user.

Typical Successful Response:

								
									
{ "success":"Success" }
Possible Errors:
  • 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
  • view does not authorize metadata access
  • the view does not allow adding a where tag
  • Coordinates not possible
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by addWhereTagForViewOnTransaction

Delete a tag.

Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view.

Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the tag.

Typical Successful Response:

								
									
{ }
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by deleteTagForViewOnTransaction

Delete an image

Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view.

Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.

Typical Successful Response:

								
									
{ }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • view does not authorize metadata access
  • User must be logged in
  • 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.
Implmented in 1_2_1 by deleteImageForViewOnTransaction

Delete comment.

Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view.

Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.

Typical Successful Response:

								
									
{ }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • view owner does not authorize metadata access
  • User must be logged in
  • You must be able to see comments in order to delete them
  • Comment not found for this transaction
  • Deleting comments not permitted for this view
  • Deleting comments not permitted for the current user
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by deleteCommentForViewOnTransaction

Delete narrative.

Deletes the description of the transaction TRANSACTION_ID.

Authentication via OAuth is required if the view is not public.

Typical Successful Response:

								
									
{ }
Possible Errors:
  • 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.
  • view does not authorize metadata access
  • view does not allow deleting the narrative
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by deleteTransactionNarrative

Delete where tag.

Deletes the where tag of the transaction TRANSACTION_ID made on view.

Authentication is Mandatory

The user must either have owner privileges for this account, or must be the user that posted the geo tag.

Typical Successful Response:

								
									
{ }
Possible Errors:
  • 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.
  • view does not authorize metadata access
  • User must be logged in
  • You must be able to see the where tag in order to delete it
  • there is no tag to delete
  • Deleting tag is not permitted for this view
  • Deleting tags not permitted for the current user
  • Delete not completed
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by deleteWhereTagForViewOnTransaction

Get comments.

Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID).

Authentication via OAuth is required if the view is not public.

Typical Successful Response:

								
									
{ "comments":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }] }
Possible Errors:
  • 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.
  • view does not authorize metadata access
  • view does not authorize comments access
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by getCommentsForViewOnTransaction

Get images.

Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID). Authentication via OAuth is required if the view is not public.

Typical Successful Response:

								
									
{ "images":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"NONE", "url":"www.openbankproject.com", "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }] }
Possible Errors:
  • 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.
  • view does not authorize metadata access
  • view does not authorize images access
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by getImagesForViewOnTransaction

Get narrative.

Returns the account owner description of the transaction moderated by the view.

Authentication via OAuth is required if the view is not public.

Typical Successful Response:

								
									
{ "narrative":"narative" }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • view does not authorize metadata access
  • view does not authorize narrative access
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by getTransactionNarrative

Get tags.

Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID). Authentication via OAuth is required if the view is not public.

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "value":"OBP", "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • view does not authorize metadata access
  • view does not authorize tag access
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by getTagsForViewOnTransaction

Get where tag.

Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID). It represents the location where the transaction has been initiated.

Authentication via OAuth is required if the view is not public.

Typical Successful Response:

								
									
{ "where":{ "latitude":1.231, "longitude":1.231, "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } } }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • view does not authorize metadata access
  • view does not authorize where tag access
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by getWhereTagForViewOnTransaction

Update narrative.

Updates the description of the transaction TRANSACTION_ID.

Authentication via OAuth is required if the view is not public.

Typical Successful Response:

								
									
{ "success":"Success" }
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • view does not authorize metadata access
  • view does not allow updating a narrative
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by updateTransactionNarrative

Update where tag.

Updates the "where" Geo tag on a transaction TRANSACTION_ID in a view.

Authentication is Mandatory

The geo tag is linked with the user.

Typical Successful Response:

								
									
{ "success":"Success" }
Possible Errors:
  • 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
  • view does not authorize metadata access
  • the view does not allow updating a where tag
  • Coordinates not possible
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by updateWhereTagForViewOnTransaction