API Explorer

API
- Get API Info (root)
Account
- Create Account
- Create View
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank
- Get Accounts at Bank (Private)
- Get Accounts at all Banks (Private)
- Get all Accounts at all Banks
- Get private accounts at one bank
- Update Account Label
- Update View
Account Public
- Get Public Accounts at Bank
- Get Public Accounts at all Banks
Bank
- Get Bank
- Get Bank ATMS
- Get Bank Products
- Get Banks
- Get Transaction Types at Bank
Branch
- Get Bank Branches
Card
- Get cards for the current user
- Get cards for the specified bank
Counterparty
- Get Other Account by Id
- Get Other Accounts of one Account
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
Customer
- Add Social Media Handle
- Create Customer
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get customer for logged in user
Customer Meeting
- Create Meeting (video conference/call)
- Get Meeting
- Get Meetings
Customer Message
- Create Customer Message
- Get Customer Messages (current)
Data Warehouse
- Search Warehouse Data Via Elasticsearch
Documentation
- Get Resource Docs
- Get Swagger documentation
KYC
- Add KYC Check
- Add KYC Document
- Add KYC Media
- Add KYC Status
- Get Customer KYC Checks
- Get Customer KYC Documents
- Get Customer KYC statuses
- Get KYC Media for a customer
Metric
- Search API Metrics via Elasticsearch
Person
- Get all customers for logged in user
Role
- Add Entitlement for a User
- Delete Entitlement
- Get Entitlements for User
- Get all Entitlements
Transaction
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
Transaction Metadata
- Add a tag
- Add an image
- Add comment
- Add narrative
- Add where tag
- Delete a tag
- Delete an image
- Delete comment
- Delete narrative
- Delete where tag
- Get comments
- Get images
- Get narrative
- Get tags
- Get where tag
- Update narrative
- Update where tag
Transaction Request
- Answer Transaction Request Challenge
- Create Transaction Request
- Get Transaction Request Types for Account
- Get Transaction Requests
User
- Create User
- Get User (Current)
- Get Users by Email Address
View (Custom)
- Delete View
- Get Account access for User
- Get Views for Account
- Get access
- Grant User access to View
- Grant User access to a list of views
- Revoke access to all Views on Account
- Revoke access to one View

Log off

v2.0.0 (115 APIs)

API Host: https://api.ttk.com.mk

Bank

Accounts

Views

Counterparties

Transactions

Get API Info (root)

Returns information about:

API version
Hosted by information
Git Commit

Authentication is Optional

JSON response body fields:

email: felixsmith@example.com
git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

Typical Successful Response:

								
									{
  "version":"String",
  "version_status":"String",
  "git_commit":"String",
  "connector":"String",
  "hosted_by":{
    "organisation":"String",
    "email":"String",
    "phone":"String",
    "organisation_website":"String"
  }
}

Headers:

Required Roles:

Possible Errors:

OBP-50000: Unknown Error.
no connector set

Connector Methods:

Implemented in OBPv1.2.1 by root, operation_id: OBPv1.2.1-root

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.

Featured APIs