API Explorer

⯆

API Explorer

My Collections

API
- The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeably
  More...
- Get API Configuration
- Get API Info (root)
- Get Adapter Info
- Get Adapter Info for a bank
- Get Connector Status (Loopback)
- Get JSON Web Key (JWK)
- Get JSON Web Key (JWK) URIs
- Get Rate Limiting Info
ATM
Account
- The thing that tokens of value (money) come in and out of. An account has one or more `owners` which
  More...
- Check Available Funds
- Create Account
- Create Account Attribute
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Balances
- 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 Checkbook orders
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
Account Application
Account Public
Bank
- A Bank (aka Space) represents a financial institution, brand or organizational unit under which res
  More...
- Create Bank
- Create Transaction Type at bank
- Get Bank
- Get Banks
- Get Transaction Types at Bank
Branch
Card
Consent
- Consents provide a mechanism through which a resource owner (e.g. a customer) can grant a third part
  More...
- Answer Consent Challenge
- Create Consent (EMAIL)
- Create Consent (IMPLICIT)
- Create Consent (SMS)
- Get Consents
- Revoke Consent
Consumer
- The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on be
  More...
- Enable or Disable Consumers
- Get Call Limits for a Consumer
- Get Consumer
- Get Consumers
- Get Consumers (logged in User)
- Set Rate Limiting (call limits) per Consumer
- Update Consumer RedirectUrl
Counterparty
Counterparty Metadata
Customer
Customer Meeting
Customer Message
Data Warehouse
Documentation
Dynamic Resource Doc
- A test endpoint
Example Title
FX
KYC
Method Routing
- Open Bank Project can have different connectors, to connect difference data sources. We support
  More...
- Create MethodRouting
- Delete MethodRouting
- Get MethodRoutings
- Update MethodRouting
Metric
Product
Product Collection
Role
Sandbox
- Create sandbox
Scope
Swagger Call getBanks
- Call Obp_Api Get Banks
Transaction
- Transactions are records of successful movements of value into or out of an `Account`. OBP Transac
  More...
- 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
Transaction Request
User
- The entity that accesses the API with a login / authorisation token and has access to zero or more
  More...
- Answer Auth Context Update Challenge
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Delete User Auth Context
- Delete User's Auth Contexts
- Get User (Current)
- Get User Auth Contexts
- Get User Lock Status
- Get User by USERNAME
- Get User by USER_ID
- Get Users by Email Address
- Get all Users
- Refresh User
- Unlock the user
View Custom
View System
WebUi Props
Webhook
_Credit Application Form
_TESTING

Log off

v3.1.0 (266 APIs)

Anfitrión de la API: https://api.ttk.com.mk

Create Customer Message

Create a message for the customer specified by CUSTOMER_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON request body fields:

from_department: Open Bank

from_person: Tom

message: 123456

JSON response body fields:

success:

Respuesta Exitosa Típica:

								
									{
  "success":"Success"
}

Request Headers:

Response Headers:

Roles Requeridos:

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.

Métodos de conector::

Version: OBPv1.4.0, function_name: by addCustomerMessage, operation_id: OBPv1.4.0-addCustomerMessage Tags: Customer-Message, Customer, Person,

Get Customer Messages for all Customers

Get messages for the logged in customer
Messages sent to the currently authenticated user.

Authentication via OAuth is required.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

date: 2020-01-27

from_department: Open Bank

from_person: Tom

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

message: 123456

messages:

Respuesta Exitosa Típica:

								
									{
  "messages":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "date":"1100-01-01T00:00:00Z",
    "message":"String",
    "from_department":"String",
    "from_person":"String"
  }]
}

Request Headers:

Response Headers:

Roles Requeridos:

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.

Métodos de conector::

Version: OBPv1.4.0, function_name: by getCustomersMessages, operation_id: OBPv1.4.0-getCustomersMessages Tags: Customer-Message, Customer,

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.
API_Explorer Commit

Featured APIs

API Explorer

v3.1.0 (266 APIs)

Create Customer Message

Get Customer Messages for all Customers