API Explorer
- API
- ATM
- Account
- Account Public
- Bank
- Branch
- Card
- Consumer
- Counterparty
-
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
- Customer Meeting
- Customer Message
- Data Warehouse
- Documentation
- FX
- KYC
- Metric
- Product
-
Role
- Add Entitlement for a User
- Create Entitlement Request for current User
- Delete Entitlement
- Delete Entitlement Request
- Get Entitlement Requests for a User
- Get Entitlement Requests for the current User
- Get Entitlements for User
- Get Entitlements for User at Bank
- Get Entitlements for the current User
- Get Roles
- Get all Entitlement Requests
- Get all Entitlements
- Sandbox
- Scope
- Transaction
- Transaction Metadata
- Transaction Request
- User
- View (Custom)
-
API
-
ATM
-
Account
- Create Account
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Held
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Firehose Accounts at Bank
- Update Account Label
-
Account Public
-
Bank
-
Branch
-
Card
-
Consumer
-
Counterparty
- Create Counterparty (Explicit)
- Get Counterparties (Explicit)
- Get Counterparty by Counterparty Id (Explicit)
- 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 Customers for Current User
- Get Customers for current User at Bank
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Documentation
-
FX
-
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
-
Product
-
Role
- Add Entitlement for a User
- Create Entitlement Request for current User
- Delete Entitlement
- Delete Entitlement Request
- Get Entitlement Requests for a User
- Get Entitlement Requests for the current User
- Get Entitlements for User
- Get Entitlements for User at Bank
- Get Entitlements for the current User
- Get Roles
- Get all Entitlement Requests
- Get all Entitlements
-
Sandbox
-
Scope
-
Transaction
- Get Firehose Transactions for Account
- 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 (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Get Transaction Request Types at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
-
User
- Create User
- Get User (Current)
- Get User by USERNAME
- Get User by USER_ID
- Get Users by Email Address
- Get all Users
-
View (Custom)
- Create View
- 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
- Update View
v3.0.0 (164 APIs)
API Host: https://api.ttk.com.mk
Bank
Accounts
Views
Counterparties
Transactions
Create Product
Typical Successful Response:
{
"bank_id":"gh.29.uk",
"code":"prod1",
"name":"product name",
"category":"category",
"family":"family",
"super_family":"super family",
"more_info_url":"www.example.com/prod1/more-info.html",
"details":"Details",
"description":"Description",
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
}
}
Required Roles:
-
CanCreateProduct
- Please login to request this Role
-
CanCreateProductAtAnyBank
- 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-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv2.2.0 by createProduct, operation_id: OBPv2.2.0-createProduct
Get Bank Product
Returns information about the financial products offered by a bank specified by BANK_ID and PRODUCT_CODE including:
- Name
- Code
- Category
- Family
- Super Family
- More info URL
- Description
- Terms and Conditions
- License the data under this endpoint is released under
Authentication is Optional
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
- bank_id: gh.29.uk
Typical Successful Response:
{
"bank_id":"bankid123",
"code":"prod1",
"name":"product name",
"category":"category",
"family":"family",
"super_family":"super family",
"more_info_url":"www.example.com/prod1/more-info.html",
"details":"Details",
"description":"Description",
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
}
}
Possible Errors:
- OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.
- OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv2.1.0 by getProduct, operation_id: OBPv2.1.0-getProduct
Get Bank Products
Returns information about the financial products offered by a bank specified by BANK_ID including:
- Name
- Code
- Category
- Family
- Super Family
- More info URL
- Description
- Terms and Conditions
- License the data under this endpoint is released under
Authentication is Optional
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
- bank_id: gh.29.uk
Typical Successful Response:
{
"products":[{
"bank_id":"bankid123",
"code":"prod1",
"name":"product name",
"category":"category",
"family":"family",
"super_family":"super family",
"more_info_url":"www.example.com/prod1/more-info.html",
"details":"Details",
"description":"Description",
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
}
}]
}
Possible Errors:
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.
- OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv2.1.0 by getProducts, operation_id: OBPv2.1.0-getProducts