API Explorer

API
- Get API Configuration
- Get API Info (root)
ATM
- Create ATM
- Get Bank ATM
Account
- Create Account
- Create View
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank
- 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
- Create Bank
- Create Transaction Type at bank
- Get Bank
- Get Bank ATMS
- Get Banks
- Get Transaction Types at Bank
Branch
- Create Branch
- Get Bank Branch
- Get Bank Branches
- Update Branch
Card
- Create Card
- Get cards for the current user
- Get cards for the specified bank
Consumer
- Enable or Disable Consumers
- Get Consumer
- Get Consumers
- Post a Consumer
- Update Consumer RedirectUrl
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 at Bank
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 Message Docs
- Get Resource Docs
- Get Swagger documentation
FX
- Get Current FxRate
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
- Get Connector Metrics
- Get Metrics
- Search API Metrics via Elasticsearch
Product
- Create Product
- Get Bank Product
- Get Bank Products
Role
- Add Entitlement for a User
- Delete Entitlement
- Get Entitlements for User
- Get Entitlements for User at Bank
- Get Roles
- Get all Entitlements
Sandbox
- Create sandbox
Transaction
- Get Other Account of Transaction
- Get Transaction by Id
- 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 Users by Email Address
- Get all Users
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.2.0 (143 APIs)

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

Create ATM

Create ATM for the Bank.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

bank_id: gh.29.uk
country: country
latitude: 38.8951
longitude: -77.0364

JSON response body fields:

bank_id: gh.29.uk
country: country
latitude: 38.8951
longitude: -77.0364

Typical Successful Response:

								
									{
  "id":"123",
  "bank_id":"gh.29.uk",
  "name":"OBP",
  "address":{
    "line_1":"Osloer Straße 16/17",
    "line_2":"Wedding",
    "line_3":"",
    "city":"Berlin",
    "state":"Berlin Brandenburg",
    "postcode":"13359",
    "country":"DE"
  },
  "location":{
    "latitude":11.45,
    "longitude":11.45
  },
  "meta":{
    "license":{
      "id":"5",
      "name":"TESOBE"
    }
  }
}

Headers:

Required Roles:

CanCreateAtm - Please login to request this Role
CanCreateAtmAtAnyBank - 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 createAtm, operation_id: OBPv2.2.0-createAtm

Get Bank ATM

Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:

Address
Geo Location
License the data under this endpoint is released under

Authentication is Optional