API Explorer

v3.1.0 (266 APIs)

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

Create Bank

Create a new bank (Authenticated access).
Authentication is Mandatory

JSON request body fields:

address:

bank_routing:

full_name: full name string

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

logo_url: logo_url

national_identifier:

scheme: scheme value

short_name:

swift_bic:

website_url: website_url

JSON response body fields:

address:

bank_routing:

full_name: full name string

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

logo_url: logo_url

national_identifier:

scheme: scheme value

short_name:

swift_bic:

website_url: website_url

Respuesta Exitosa Típica:

								
									
{ "id":"gh.29.uk.x", "full_name":"uk", "short_name":"uk", "logo_url":"https://static.openbankproject.com/images/sandbox/bank_x.png", "website_url":"https://www.example.com", "swift_bic":"IIIGGB22", "national_identifier":"UK97ZZZ1234567890", "bank_routing":{ "scheme":"BIC", "address":"OKOYFIHH" } }
Roles Requeridos:
  • CanCreateBank - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-10001: Incorrect json format.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30210: Insufficient authorisation to Create Bank. You do not have the role CanCreateBank.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv2.2.0, function_name: by createBank, operation_id: OBPv2.2.0-createBank Tags: Bank, Old-Style,

Create Transaction Type at bank

Create Transaction Types for the bank specified by BANK_ID:

  • id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.
  • bank_id : The bank that supports this TransactionType
  • short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here
  • summary : A succinct summary
  • description : A longer description
  • charge : The charge to the customer for each one of these

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12

bankId:

charge:

currency: EUR

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

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

shortCode:

summary:

value: 5987953

Respuesta Exitosa Típica:

								
									
{ "id":{ "value":"123" }, "bankId":{ "value":"gh.uk.9j" }, "shortCode":"80080", "summary":"SANDBOX_TAN", "description":"This is the sandbox mode, charging litter money.", "charge":{ "currency":"EUR", "amount":"100" } }
Roles Requeridos:
  • CanCreateTransactionType - Please login to request this Role
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-10001: Incorrect json format.
  • OBP-40005: Insufficient authorisation to Create Transaction Type offered by the bank. The Request could not be created because you don't have access to CanCreateTransactionType.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv2.1.0, function_name: by createTransactionType, operation_id: OBPv2.1.0-createTransactionType Tags: Bank,

Get Bank

Get the bank specified by BANK_ID
Returns information about a single bank specified by BANK_ID including:

  • Short and full name of bank
  • Logo URL
  • Website

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

address:

bank_routings: bank routing in form of (scheme, address)

full_name: full name string

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

logo: logo url

name: ACCOUNT_MANAGEMENT_FEE

scheme: scheme value

short_name:

value: 5987953

website: www.openbankproject.com

attributes: attribute value in form of (name, value)

Respuesta Exitosa Típica:

								
									
{ "id":"gh.29.uk", "short_name":"short_name ", "full_name":"full_name", "logo":"logo", "website":"www.openbankproject.com", "bank_routings":[{ "scheme":"scheme value", "address":"" }], "attributes":[{ "name":"ACCOUNT_MANAGEMENT_FEE", "value":"5987953" }] }
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.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
Métodos de conector::
Version: OBPv3.0.0, function_name: by bankById, operation_id: OBPv3.0.0-bankById Tags: Bank, Account Information Service (AIS), PSD2,

Get Banks

Get banks on this API instance
Returns a list of banks supported on this server:

  • ID used as parameter in URLs
  • Short and full name of bank
  • Logo URL
  • Website

Authentication is Optional

JSON response body fields:

address:

bank_routing:

banks:

full_name: full name string

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

logo: logo url

scheme: scheme value

short_name:

website: www.openbankproject.com

Respuesta Exitosa Típica:

								
									
{ "banks":[{ "id":"gh.29.uk", "short_name":"short_name ", "full_name":"full_name", "logo":"logo", "website":"www.openbankproject.com", "bank_routing":{ "scheme":"scheme value", "address":"" } }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.0.0, function_name: by getBanks, operation_id: OBPv3.0.0-getBanks Tags: Bank, Account Information Service (AIS), PSD2,

Get Transaction Types at Bank

Get Transaction Types for the bank specified by BANK_ID:

Lists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).

  • id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.
  • bank_id : The bank that supports this TransactionType
  • short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here
  • summary : A succinct summary
  • description : A longer description
  • charge : The charge to the customer for each one of these

Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

charge:

currency: EUR

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

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

short_code:

summary:

transaction_types:

value: 5987953

Respuesta Exitosa Típica:

								
									
{ "transaction_types":[{ "id":{ "value":"123" }, "bank_id":"gh.29.uk", "short_code":"PlaceholderString", "summary":"PlaceholderString", "description":"PlaceholderString", "charge":{ "currency":"EUR", "amount":"0" } }] }
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv2.0.0, function_name: by getTransactionTypes, operation_id: OBPv2.0.0-getTransactionTypes Tags: Bank, Account Information Service (AIS), PSD2,