API Explorer

v5.1.0 filtered by tag: PrivateData (2 APIs)

Anfitrión de la API: https://api.ttk.com.mk
Banco
Cuentas
Vistas
Contrapartes
Transacciones

Get Accounts at Bank

Returns the list of accounts at BANK_ID that the user has access to.
For each account the API returns the account ID and the views available to the user..
Each account must have at least one private View.

optional request parameters for filter with attributes
URL params example: /banks/some-bank-id/accounts?manager=John&count=8

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

accounts:

bank_id: gh.29.uk

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

is_public: true

label: My Account

short_name:

views_available:

Respuesta Exitosa Típica:

								
									
{ "accounts":[{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "bank_id":"gh.29.uk", "views_available":[{ "id":"1", "short_name":"HHH", "is_public":true }] }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getPrivateAccountsAtOneBank, operation_id: OBPv4.0.0-getPrivateAccountsAtOneBank Tags: Account, PrivateData, PublicData,

Get Accounts at all Banks (private)

Returns the list of accounts containing private views for the user.
Each account lists the views available to the user.

optional request parameters:

  • account_type_filter: one or many accountType value, split by comma
  • account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE

whole url example:
/my/accounts?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE

Authentication is Mandatory

JSON response body fields:

account_routings:

account_type: AC

accounts:

address:

bank_id: gh.29.uk

description: This an optional field. Maximum length is 2000. It can be any characters here.

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

is_public: true

label: My Account

scheme: scheme value

short_name:

views:

Respuesta Exitosa Típica:

								
									
{ "accounts":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"String", "bank_id":"gh.29.uk", "account_type":"330", "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "views":[{ "id":"owner", "short_name":"owner", "description":"This view is for the owner for the account.", "is_public":false }] }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Version: OBPv3.0.0, function_name: by corePrivateAccountsAllBanks, operation_id: OBPv3.0.0-corePrivateAccountsAllBanks Tags: Account, Account Information Service (AIS), PrivateData, PSD2,