right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (598 APIs)

API Host: https://ifcsandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Add a Transaction 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.

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

value: 5987953

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

Typical Successful Response: 

								
									
{
  "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"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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.
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCommentForViewOnTransaction, operation_id: OBPv1.2.1-addCommentForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Add a Transaction Image

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

Authentication is Mandatory

The image is linked with the user.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

URL: http://www.example.com/id-docs/123/image.png

label: My Account

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

provider: ETHEREUM

user:

Typical Successful Response: 

								
									
{
  "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"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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!
Connector Methods:
Version: OBPv1.2.1, function_name: by addImageForViewOnTransaction, operation_id: OBPv1.2.1-addImageForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Add a Transaction 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.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

narrative:

JSON response body fields:

success:

Typical Successful Response: 

								
									
{
  "success":"Success"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addTransactionNarrative, operation_id: OBPv1.2.1-addTransactionNarrative Tags: Transaction-Metadata, Transaction,

Add a Transaction 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.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

value: 5987953

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

Typical Successful Response: 

								
									
{
  "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"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addTagForViewOnTransaction, operation_id: OBPv1.2.1-addTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Add a Transaction 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.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON request body fields:

latitude: 38.8951

longitude: -77.0364

where:

JSON response body fields:

success:

Typical Successful Response: 

								
									
{
  "success":"Success"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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
  • OBP-30022: The current view does not have the permission:
  • Coordinates not possible
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by addWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-addWhereTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Delete a Transaction 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.

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

COMMENT_ID:

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCommentForViewOnTransaction, operation_id: OBPv1.2.1-deleteCommentForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Delete a Transaction 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.

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

IMAGE_ID:

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteImageForViewOnTransaction, operation_id: OBPv1.2.1-deleteImageForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Delete a Transaction Narrative

Deletes the description of the transaction TRANSACTION_ID.

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

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-30022: The current view does not have the permission:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteTransactionNarrative, operation_id: OBPv1.2.1-deleteTransactionNarrative Tags: Transaction-Metadata, Transaction,

Delete a Transaction 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.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-deleteWhereTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Delete a Transaction 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.

Authentication is Optional

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TAG_ID:

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteTagForViewOnTransaction, operation_id: OBPv1.2.1-deleteTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Get Transaction Comments

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

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

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

comments:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

Typical Successful Response: 

								
									
{
  "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"
    }
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-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.
Connector Methods:
Version: OBPv1.2.1, function_name: by getCommentsForViewOnTransaction, operation_id: OBPv1.2.1-getCommentsForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Get Transaction Images

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

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

images:

label: My Account

provider: ETHEREUM

user:

Typical Successful Response: 

								
									
{
  "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"
    }
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-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.
Connector Methods:
Version: OBPv1.2.1, function_name: by getImagesForViewOnTransaction, operation_id: OBPv1.2.1-getImagesForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Get Transaction Tags

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

Authentication is Optional

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

Typical Successful Response: 

								
									
{
  "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"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by getTagsForViewOnTransaction, operation_id: OBPv1.2.1-getTagsForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Get a Transaction Narrative

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

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

Authentication is Optional

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

narrative:

Typical Successful Response: 

								
									
{
  "narrative":"narative"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by getTransactionNarrative, operation_id: OBPv1.2.1-getTransactionNarrative Tags: Transaction-Metadata, Transaction,

Get a Transaction 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.

Authentication is Optional

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

latitude: 38.8951

longitude: -77.0364

provider: ETHEREUM

user:

where:

Typical Successful Response: 

								
									
{
  "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"
    }
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by getWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-getWhereTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Update a Transaction Narrative

Updates the description of the transaction TRANSACTION_ID.

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

Authentication is Optional

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

success:

Typical Successful Response: 

								
									
{
  "success":"Success"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateTransactionNarrative, operation_id: OBPv1.2.1-updateTransactionNarrative Tags: Transaction-Metadata, Transaction,

Update a Transaction 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.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

success:

Typical Successful Response: 

								
									
{
  "success":"Success"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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
  • OBP-30022: The current view does not have the permission:
  • Coordinates not possible
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-updateWhereTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,