API Explorer
- API
- ATM
-
Account
- Check Available Funds
- Create Account (POST)
- Create Account Attribute
- Create or Update Account Attribute Definition
- Delete Account Attribute Definition
- Delete Account Cascade
- Get Account Attribute Definition
- Get Account by Account Routing
- 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
- Validate and check IBAN number
- Account Access
- Account Application
- Account Metadata
- Account Public
- Authentication Type Validation
- Bank
- Branch
- Card
- Consent
- 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
- Add Social Media Handle
- Create Address
- Create Credit Limit Order Request
- Create Customer
- Create Customer Attribute
- Create Tax Residence
- Create User Customer Link
- Create or Update Customer Attribute Definition
- Delete Customer Address
- Delete Customer Attribute
- Delete Customer Attribute Definition
- Delete Tax Residence
- Delete User Customer Link
- Get CRM Events
- Get Credit Limit Order Request By Request Id
- Get Credit Limit Order Requests
- Get Customer Addresses
- Get Customer Attribute By Id
- Get Customer Attribute Definition
- Get Customer Attributes
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers by ATTRIBUTES
- Get Customers by MOBILE_PHONE_NUMBER
- Get Customers for Current User
- Get Firehose Customers
- Get Tax Residences of Customer
- Get User Customer Links by Customer
- Get User Customer Links by User
- Update Customer Attribute
- Update the Address of a Customer
- Update the Branch of a Customer
- Update the credit limit of a Customer
- Update the credit rating and source of a Customer
- Update the email of a Customer
- Update the identity data of a Customer
- Update the mobile number of a Customer
- Update the number of a Customer
- Update the other data of a Customer
- Customer Meeting
- Customer Message
- Data Warehouse
- Direct Debit
- Documentation
- Dynamic Endpoint (Manage)
- Dynamic Entity (Manage)
- Example Title
- FX
- JSON Schema Validation
- KYC
- Method Routing
- Metric
- Product
- Product Collection
-
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 One Bank
- 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
- Standing Order
- Swagger Call getBanks
-
Transaction
- Create Transaction Attribute
- Create or Update Transaction Attribute Definition
- Delete Transaction Attribute Definition
- Delete Transaction Cascade
- Get Double Entry Transaction
- Get Firehose Transactions for Account
- Get Other Account of Transaction
- Get Transaction Attribute By Id
- Get Transaction Attribute Definition
- Get Transaction Attributes
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
- Update Transaction Attribute
- Transaction Metadata
-
Transaction Request
- Answer Transaction Request Challenge
- Create Transaction Request (ACCOUNT)
- Create Transaction Request (ACCOUNT_OTP)
- Create Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (REFUND)
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Create Transaction Request Attribute
- Create or Update Transaction Request Attribute Definition
- Delete Transaction Request Attribute Definition
- Get Transaction Request
- Get Transaction Request Attribute By Id
- Get Transaction Request Attribute Definition
- Get Transaction Request Attributes
- Get Transaction Request Types at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
- Save Historical Transactions
- Update Transaction Request Attribute
-
User
- Answer Auth Context Update Challenge
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Create password reset url
- Delete User Auth Context
- Delete User's Auth Contexts
- Get Logout Link
- 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
- Lock the user
- Refresh User
- Unlock the user
- View (Custom)
- View (System)
- WebUi Props
- Webhook
- _CreditApplicationForm
- _TESTING
-
API
-
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 Mapper Database Info
-
Get Rate Limiting Info
-
Get the Call Context of a current call
-
Get API Configuration
-
ATM
-
Account
-
Check Available Funds
-
Create Account (POST)
-
Create Account Attribute
-
Create or Update Account Attribute Definition
-
Delete Account Attribute Definition
-
Delete Account Cascade
-
Get Account Attribute Definition
-
Get Account by Account Routing
-
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
-
Validate and check IBAN number
-
Check Available Funds
-
Account Access
-
Account Application
-
Create Account Application
-
Get Account Application by Id
-
Get Account Applications
-
Update Account Application Status
-
Create Account Application
-
Account Metadata
-
Account Public
-
Authentication Type Validation
-
Create a Authentication Type Validation
-
Delete a Authentication Type Validation
-
Get a Authentication Type Validation
-
Get all Authentication Type Validations
-
Update a Authentication Type Validation
-
Create a Authentication Type Validation
-
Bank
-
Create Bank
-
Create Settlement Account
-
Create Transaction Type at bank
-
Get Bank
-
Get Banks
-
Get Settlement accounts at Bank
-
Get Transaction Types at Bank
-
Create Bank
-
Branch
-
Card
-
Create Card
-
Create Card Attribute
-
Create or Update Card Attribute Definition
-
Delete Card
-
Delete Card Attribute Definition
-
Get Card Attribute Definition
-
Get Card By Id
-
Get Cards for the specified bank
-
Get cards for the current user
-
Get status of Credit Card order
-
Update Card
-
Update Card Attribute
-
Create Card
-
Consent
-
Add User to a Consent
-
Answer Consent Challenge
-
Create Consent (EMAIL)
-
Create Consent (SMS)
-
Get Consents
-
Revoke Consent
-
Update Consent Status
-
Add User to a Consent
-
Consumer
-
Enable or Disable Consumers
-
Get Call Limits for a Consumer
-
Get Consumer
-
Get Consumers
-
Get Consumers (logged in User)
-
Post a Consumer
-
Set Calls Limit for a Consumer
-
Update Consumer RedirectUrl
-
Enable or Disable Consumers
-
Counterparty
-
Create Counterparty (Explicit)
-
Create Counterparty for any account (Explicit)
-
Get Counterparties (Explicit)
-
Get Counterparty by Counterparty Id (Explicit)
-
Get Counterparty by name for any account (Explicit)
-
Get Other Account by Id
-
Get Other Accounts of one Account
-
Create Counterparty (Explicit)
-
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
-
Add Corporate Location to Counterparty
-
Customer
-
Add Social Media Handle
-
Create Address
-
Create Credit Limit Order Request
-
Create Customer
-
Create Customer Attribute
-
Create Tax Residence
-
Create User Customer Link
-
Create or Update Customer Attribute Definition
-
Delete Customer Address
-
Delete Customer Attribute
-
Delete Customer Attribute Definition
-
Delete Tax Residence
-
Delete User Customer Link
-
Get CRM Events
-
Get Credit Limit Order Request By Request Id
-
Get Credit Limit Order Requests
-
Get Customer Addresses
-
Get Customer Attribute By Id
-
Get Customer Attribute Definition
-
Get Customer Attributes
-
Get Customer Social Media Handles
-
Get Customer by CUSTOMER_ID
-
Get Customer by CUSTOMER_NUMBER
-
Get Customers by ATTRIBUTES
-
Get Customers by MOBILE_PHONE_NUMBER
-
Get Customers for Current User
-
Get Firehose Customers
-
Get Tax Residences of Customer
-
Get User Customer Links by Customer
-
Get User Customer Links by User
-
Update Customer Attribute
-
Update the Address of a Customer
-
Update the Branch of a Customer
-
Update the credit limit of a Customer
-
Update the credit rating and source of a Customer
-
Update the email of a Customer
-
Update the identity data of a Customer
-
Update the mobile number of a Customer
-
Update the number of a Customer
-
Update the other data of a Customer
-
Add Social Media Handle
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Direct Debit
-
Documentation
-
Get API Glossary
-
Get Message Docs
-
Get Message Docs Swagger
-
Get Resource Docs
-
Get Swagger documentation
-
Get scanned API Versions
-
Get API Glossary
-
Dynamic Endpoint (Manage)
-
Create Dynamic Endpoint
-
Delete Dynamic Endpoint
-
Get Dynamic Endpoint
-
Get Dynamic Endpoints
-
Delete My Dynamic Endpoint
-
Get My Dynamic Endpoints
-
Create Dynamic Endpoint
-
Dynamic Entity (Manage)
-
Create Dynamic Entity
-
Delete Dynamic Entity
-
Delete My Dynamic Entity
-
Get Bank Level Dynamic Entities
-
Get Dynamic Entities
-
Get My Dynamic Entities
-
Update Dynamic Entity
-
Update My Dynamic Entity
-
Create Dynamic Entity
-
Example Title
-
FX
-
JSON Schema Validation
-
Create a JSON Schema Validation
-
Delete a JSON Schema Validation
-
Get a JSON Schema Validation
-
Get all JSON Schema Validations
-
Update a JSON Schema Validation
-
Create a JSON Schema Validation
-
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
-
Add KYC Check
-
Method Routing
-
Metric
-
Get Aggregate Metrics
-
Get Connector Metrics
-
Get Metrics
-
Get Top APIs
-
Get Top Consumers
-
Search API Metrics via Elasticsearch
-
Get Aggregate Metrics
-
Product
-
Create Product
-
Create Product Attribute
-
Create or Update Product Attribute Definition
-
Delete Product Attribute
-
Delete Product Attribute Definition
-
Delete Product Cascade
-
Get Bank Product
-
Get Product Attribute
-
Get Product Attribute Definition
-
Get Product Tree
-
Get Products
-
Update Product Attribute
-
Create Product
-
Product Collection
-
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 One Bank
-
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
-
Add Entitlement for a User
-
Sandbox
-
Scope
-
Standing Order
-
Swagger Call getBanks
-
Transaction
-
Create Transaction Attribute
-
Create or Update Transaction Attribute Definition
-
Delete Transaction Attribute Definition
-
Delete Transaction Cascade
-
Get Double Entry Transaction
-
Get Firehose Transactions for Account
-
Get Other Account of Transaction
-
Get Transaction Attribute By Id
-
Get Transaction Attribute Definition
-
Get Transaction Attributes
-
Get Transaction by Id
-
Get Transactions for Account (Core)
-
Get Transactions for Account (Full)
-
Update Transaction Attribute
-
Create Transaction Attribute
-
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
-
Add a tag
-
Transaction Request
-
Answer Transaction Request Challenge
-
Create Transaction Request (ACCOUNT)
-
Create Transaction Request (ACCOUNT_OTP)
-
Create Transaction Request (COUNTERPARTY)
-
Create Transaction Request (FREE_FORM)
-
Create Transaction Request (REFUND)
-
Create Transaction Request (SANDBOX_TAN)
-
Create Transaction Request (SEPA)
-
Create Transaction Request Attribute
-
Create or Update Transaction Request Attribute Definition
-
Delete Transaction Request Attribute Definition
-
Get Transaction Request
-
Get Transaction Request Attribute By Id
-
Get Transaction Request Attribute Definition
-
Get Transaction Request Attributes
-
Get Transaction Request Types at Bank
-
Get Transaction Request Types for Account
-
Get Transaction Requests
-
Save Historical Transactions
-
Update Transaction Request Attribute
-
Answer Transaction Request Challenge
-
User
-
Answer Auth Context Update Challenge
-
Create User
-
Create User Auth Context
-
Create User Auth Context Update Request
-
Create password reset url
-
Delete User Auth Context
-
Delete User's Auth Contexts
-
Get Logout Link
-
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
-
Lock the user
-
Refresh User
-
Unlock the user
-
Answer Auth Context Update Challenge
-
View (Custom)
-
View (System)
-
WebUi Props
-
Webhook
-
_CreditApplicationForm
-
Create new Credit Application Form
-
Delete Credit Application Form by id
-
Get Credit Application Form List
-
Get Credit Application Form by id
-
Update Credit Application Form
-
Create new Credit Application Form
-
_TESTING
v4.0.0 (353 APIs)
Get API Glossary
{
"glossary_items":[{
"title":"Dr.",
"description":{
"markdown":"String",
"html":"String"
}
}]
}
- OBP-50000: Unknown Error.
Get Message Docs
These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.
Integrators can use these messages to build Adapters that provide core banking services to OBP.
Note: API Explorer provides a Message Docs page where these messages are displayed.
CONNECTOR
:kafka_vMar2017 , kafka_vJune2017, kafka_vSept2018, stored_procedure_vDec2019 ...
Authentication is Optional
URL Parameters:
JSON response body fields:
- data.bankId: data.bankId
{
"message_docs":[{
"process":"getAccounts",
"message_format":"KafkaV2017",
"outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts",
"inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts",
"description":"get Banks",
"example_outbound_message":{
"jsonString":"{}"
},
"example_inbound_message":{
"jsonString":"{}"
},
"outboundAvroSchema":{
"jsonString":"{}"
},
"inboundAvroSchema":{
"jsonString":"{}"
},
"adapter_implementation":{
"group":"CORE",
"suggested_order":3
},
"dependent_endpoints":[{
"name":"getAccounts",
"version":"OBPv3.0.0"
},{
"name":"getBalances",
"version":"OBPv2.0.0"
}],
"requiredFieldInfo":{
"data.bankId":["v2.2.0","v3.1.0"]
}
}]
}
- OBP-50000: Unknown Error.
Get Message Docs Swagger
This endpoint provides example message docs in swagger format.
It is only relavent for REST Connectors.
This endpoint can be used by the developer building a REST Adapter that connects to the Core Banking System (CBS).
That is, the Adapter developer can use the Swagger surfaced here to build the REST APIs that the OBP REST connector will call to consume CBS services.
i.e.:
OBP API (Core OBP API code) -> OBP REST Connector (OBP REST Connector code) -> OBP REST Adapter (Adapter developer code) -> CBS (Main Frame)
Authentication is Optional
URL Parameters:
JSON response body fields:
- data.bankId: data.bankId
{
"message_docs":[{
"process":"getAccounts",
"message_format":"KafkaV2017",
"outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts",
"inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts",
"description":"get Banks",
"example_outbound_message":{
"jsonString":"{}"
},
"example_inbound_message":{
"jsonString":"{}"
},
"outboundAvroSchema":{
"jsonString":"{}"
},
"inboundAvroSchema":{
"jsonString":"{}"
},
"adapter_implementation":{
"group":"CORE",
"suggested_order":3
},
"dependent_endpoints":[{
"name":"getAccounts",
"version":"OBPv3.0.0"
},{
"name":"getBalances",
"version":"OBPv2.0.0"
}],
"requiredFieldInfo":{
"data.bankId":["v2.2.0","v3.1.0"]
}
}]
}
- OBP-50000: Unknown Error.
Get Resource Docs
Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.
This endpoint is used by OBP API Explorer to display and work with the API documentation.
Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
API_VERSION is the version you want documentation about e.g. v3.0.0
You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.
You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.
You may need some other language resource docs, now we support en and zh , e.g. ?language=zh
See the Resource Doc endpoint for more information.
Following are more examples:
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp?tags=Account,Bank
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp?functions=getBanks,bankById
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v4.0.0/obp?language=zh
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
- operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
- version references the version that the API call is defined in.
- function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
- request_url is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource
- specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.
- summary is a short description inline with the swagger terminology.
- description may contain html markup (generated from markdown on the server).
Authentication is Optional
URL Parameters:
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-50000: Unknown Error.
Get Swagger documentation
Returns documentation about the RESTful resources on this server in Swagger format.
API_VERSION is the version you want documentation about e.g. v3.0.0
You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank
(All endpoints are given one or more tags which for used in grouping)
You may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById
(Each endpoint is implemented in the OBP Scala code by a 'function')
See the Resource Doc endpoint for more information.
Following are more examples:
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById
Authentication is Optional
URL Parameters:
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-50000: Unknown Error.
Get scanned API Versions
Get all the scanned API Versions.
Authentication is Optional
JSON response body fields:
-
apiShortVersion: apiShortVersion
-
apiStandard: apiStandard
-
scanned_api_versions: scanned_api_versions
-
urlPrefix: urlPrefix
{
"scanned_api_versions":[{
"urlPrefix":"obp",
"apiStandard":"obp",
"apiShortVersion":"v3.1.0",
"API_VERSION":"v3.1.0"
}]
}
- OBP-50000: Unknown Error.