right logo image
right logo image
Log on

API Explorer

Log off

v4.0.0 (353 APIs)

API Host: https://api.ttk.com.mk
Bank
Accounts
Views
Counterparties
Transactions

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.

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "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"
  }
}
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:
Implemented in OBPv1.2.1 by addTagForViewOnTransaction, operation_id: OBPv1.2.1-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.

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "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"
  }
}
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:
Implemented in OBPv1.2.1 by addImageForViewOnTransaction, operation_id: OBPv1.2.1-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.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "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"
  }
}
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:
Implemented in OBPv1.2.1 by addCommentForViewOnTransaction, operation_id: OBPv1.2.1-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.

URL Parameters:

JSON request body fields:

JSON response body fields:

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.
  • 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:
Implemented in OBPv1.2.1 by addTransactionNarrative, operation_id: OBPv1.2.1-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.

URL Parameters:

JSON request body fields:

JSON response body fields:

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
  • OBP-30022: The current view does not have the permission:
  • Coordinates not possible
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by addWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-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.

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
Implemented in OBPv1.2.1 by deleteTagForViewOnTransaction, operation_id: OBPv1.2.1-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.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
Implemented in OBPv1.2.1 by deleteImageForViewOnTransaction, operation_id: OBPv1.2.1-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.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
Implemented in OBPv1.2.1 by deleteCommentForViewOnTransaction, operation_id: OBPv1.2.1-deleteCommentForViewOnTransaction

Delete 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:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
Implemented in OBPv1.2.1 by deleteTransactionNarrative, operation_id: OBPv1.2.1-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.

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
Implemented in OBPv1.2.1 by deleteWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-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.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "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"
    }
  }]
}
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:
Implemented in OBPv1.2.1 by getCommentsForViewOnTransaction, operation_id: OBPv1.2.1-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.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "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"
    }
  }]
}
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:
Implemented in OBPv1.2.1 by getImagesForViewOnTransaction, operation_id: OBPv1.2.1-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.

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "narrative":"narative"
}
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:
Implemented in OBPv1.2.1 by getTransactionNarrative, operation_id: OBPv1.2.1-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.

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "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"
  }
}
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:
Implemented in OBPv1.2.1 by getTagsForViewOnTransaction, operation_id: OBPv1.2.1-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.

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "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-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:
Implemented in OBPv1.2.1 by getWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-getWhereTagForViewOnTransaction

Update 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:

JSON response body fields:

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.
  • 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:
Implemented in OBPv1.2.1 by updateTransactionNarrative, operation_id: OBPv1.2.1-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.

URL Parameters:

JSON response body fields:

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
  • OBP-30022: The current view does not have the permission:
  • Coordinates not possible
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by updateWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-updateWhereTagForViewOnTransaction