-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- 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
-
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- 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
-
-
Bank
-
A Bank (aka Space) represents a financial institution, brand or organizational unit under which resMore...
- Create Bank
- Create Transaction Type at bank
- Get Bank
- Get Banks
- Get Transaction Types at Bank
-
-
Consent
-
Consents provide a mechanism by which a third party App or User can access resources on behalf of aMore...
- 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 beMore...
- 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 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
-
The legal entity that has the relationship to the bank. Customers are linked to Users via `User CusMore...
- Create Address
- Create Customer
- Create Customer Social Media Handle
- Create Tax Residence
- Create User Customer Link
- Delete Customer Address
- Delete Tax Residence
- Get CRM Events
- Get Customer Addresses
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers for Current User
- Get Customers for current User at Bank
- Get Firehose Customers
- Get Tax Residences of Customer
- 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
-
-
Method Routing
-
Open Bank Project can have different connectors, to connect difference data sources. We supportMore...
- Create MethodRouting
- Delete MethodRouting
- Get MethodRoutings
- Update MethodRouting
-
-
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 User
- Get Entitlements for User at Bank
- Get Entitlements for the current User
- Get Roles
- Get all Entitlement Requests
- Get all Entitlements
-
Transaction
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- 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
- Add a Transaction Comment
- Add a Transaction Image
- Add a Transaction Narrative
- Add a Transaction Tag
- Add a Transaction where Tag
- Delete a Transaction Comment
- Delete a Transaction Image
- Delete a Transaction Narrative
- Delete a Transaction Tag
- Delete a Transaction Tag
- Get Transaction Comments
- Get Transaction Images
- Get Transaction Tags
- Get a Transaction Narrative
- Get a Transaction where Tag
- Update a Transaction Narrative
- Update a Transaction 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
- Save Historical Transactions
-
User
-
The entity that accesses the API with a login / authorisation token and has access to zero or moreMore...
- 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
-
-
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 Rate Limiting Info
-
Get API Configuration
-
ATM
-
Account
-
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
-
Check Available Funds
-
Account Application
-
Create Account Application
-
Get Account Application by Id
-
Get Account Applications
-
Update Account Application Status
-
Create Account Application
-
Account Public
-
Bank
-
Branch
-
Card
-
Create Card
-
Create Card Attribute
-
Delete Card
-
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
-
Answer Consent Challenge
-
Create Consent (EMAIL)
-
Create Consent (IMPLICIT)
-
Create Consent (SMS)
-
Get Consents
-
Revoke Consent
-
Answer Consent Challenge
-
Consumer
-
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
-
Enable or Disable Consumers
-
Counterparty
-
Create Counterparty (Explicit)
-
Get Counterparties (Explicit)
-
Get Counterparty by Counterparty Id (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
-
Create Address
-
Create Customer
-
Create Customer Social Media Handle
-
Create Tax Residence
-
Create User Customer Link
-
Delete Customer Address
-
Delete Tax Residence
-
Get CRM Events
-
Get Customer Addresses
-
Get Customer Social Media Handles
-
Get Customer by CUSTOMER_ID
-
Get Customer by CUSTOMER_NUMBER
-
Get Customers for Current User
-
Get Customers for current User at Bank
-
Get Firehose Customers
-
Get Tax Residences of Customer
-
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
-
Create Address
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Documentation
-
Get Bank Level Dynamic Resource Docs
-
Get Glossary of the API
-
Get Message Docs
-
Get Message Docs Swagger
-
Get Resource Docs
-
Get Resource Docs
-
Get Swagger documentation
-
Get Bank Level Dynamic Resource Docs
-
Dynamic Resource Doc
-
Example Title
-
FX
-
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
-
Delete Product Attribute
-
Get Bank Product
-
Get Product Attribute
-
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 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
-
Swagger Call getBanks
-
Transaction
-
Get Firehose Transactions for Account
-
Get Other Account of Transaction
-
Get Transaction by Id
-
Get Transactions for Account (Core)
-
Get Transactions for Account (Full)
-
Get Firehose Transactions for Account
-
Transaction Metadata
-
Add a Transaction Comment
-
Add a Transaction Image
-
Add a Transaction Narrative
-
Add a Transaction Tag
-
Add a Transaction where Tag
-
Delete a Transaction Comment
-
Delete a Transaction Image
-
Delete a Transaction Narrative
-
Delete a Transaction Tag
-
Delete a Transaction Tag
-
Get Transaction Comments
-
Get Transaction Images
-
Get Transaction Tags
-
Get a Transaction Narrative
-
Get a Transaction where Tag
-
Update a Transaction Narrative
-
Update a Transaction where Tag
-
Add a Transaction Comment
-
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
-
Save Historical Transactions
-
Answer Transaction Request Challenge
-
User
-
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
-
Answer Auth Context Update Challenge
-
View Custom
-
Create Custom View
-
Delete Custom 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
-
Update Custom View
-
Create Custom View
-
View System
-
WebUi Props
-
Webhook
-
_Credit Application Form
-
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
v3.1.0 (266 APIs)
Create MethodRouting
Create a MethodRouting.
Authentication is Mandatory
Explanation of Fields:
- method_name is required String value, current supported value: [mapped | stored_procedure_vDec2019 | rest_vMar2019]
- connector_name is required String value
- is_bank_id_exact_match is required boolean value, if bank_id_pattern is exact bank_id value, this value is true; if bank_id_pattern is null or a regex, this value is false
- bank_id_pattern is optional String value, it can be null, a exact bank_id or a regex
- parameters is optional array of key value pairs. You can set some parameters for this method
note and CAVEAT!:
- bank_id_pattern has to be empty for methods that do not take bank_id as a function parameter, otherwise might get empty result
- methods that aggregate bank objects (e.g. getBankAccountsForUser) have to take any existing method routings for these objects into consideration
- so if you create e.g. a bank specific method routing for getting an account, make sure that it is also served by endpoints getting ALL accounts for ALL banks
- if bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = "some-id_pattern_\d+"
If the connector name starts with rest, parameters can contain "outBoundMapping" and "inBoundMapping", convert OutBound and InBound json structure.
for example:
outBoundMapping example, convert json from source to target:
Build OutBound json value rules:
1 set cId value with: outboundAdapterCallContext.correlationId value
2 set bankId value with: concat bankId.value value with string helloworld
3 set originalJson value with: whole source json, note: the field value expression is $root
inBoundMapping example, convert json from source to target:
Build InBound json value rules:
1 and 2 set inboundAdapterCallContext and status value: because field name ends with "$default", remove "$default" from field name, not change the value
3 set fullName value with: concat string full: with result.name value
4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].
JSON request body fields:
key: CustomerNumber
value: 5987953
JSON response body fields:
key: CustomerNumber
value: 5987953
{
"is_bank_id_exact_match":false,
"method_name":"getBank",
"connector_name":"rest_vMar2019",
"method_routing_id":"this-method-routing-Id",
"bank_id_pattern":"some_bankId_.*",
"parameters":[{
"key":"url",
"value":"http://mydomain.com/xxx"
}]
}
-
CanCreateMethodRouting
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-10021: Incorrect Connector name.
- OBP-10022: Incorrect Connector method name.
- OBP-50000: Unknown Error.
Delete MethodRouting
Delete a MethodRouting specified by METHOD_ROUTING_ID.
Authentication is Mandatory
URL Parameters:
JSON response body fields:
-
CanDeleteMethodRouting
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get MethodRoutings
Get the all MethodRoutings.
Query url parameters:
- method_name: filter with method_name
- active: if active = true, it will show all the webui_ props. Even if they are set yet, we will return all the default webui_ props
eg:
https://api-explorer.ttk.com.mk/obp/v3.1.0/management/method_routings?active=true
https://api-explorer.ttk.com.mk/obp/v3.1.0/management/method_routings?method_name=getBank
Authentication is Mandatory
JSON response body fields:
key: CustomerNumber
value: 5987953
{
"method_routings":[{
"is_bank_id_exact_match":false,
"method_name":"getBanks",
"connector_name":"rest_vMar2019",
"method_routing_id":"method-routing-id",
"bank_id_pattern":"some_bank_.*",
"parameters":[{
"key":"url",
"value":"http://mydomain.com/xxx"
}]
}]
}
-
CanGetMethodRoutings
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Update MethodRouting
Update a MethodRouting.
Authentication is Mandatory
Explaination of Fields:
- method_name is required String value, current supported value: [mapped | stored_procedure_vDec2019 | rest_vMar2019]
- connector_name is required String value
- is_bank_id_exact_match is required boolean value, if bank_id_pattern is exact bank_id value, this value is true; if bank_id_pattern is null or a regex, this value is false
- bank_id_pattern is optional String value, it can be null, a exact bank_id or a regex
- parameters is optional array of key value pairs. You can set some paremeters for this method
note: -
if bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = "some-id_pattern_\d+"
If connector name start with rest, parameters can contain "outBoundMapping" and "inBoundMapping", to convert OutBound and InBound json structure.
for example:
outBoundMapping example, convert json from source to target:
Build OutBound json value rules:
1 set cId value with: outboundAdapterCallContext.correlationId value
2 set bankId value with: concat bankId.value value with string helloworld
3 set originalJson value with: whole source json, note: the field value expression is $root
inBoundMapping example, convert json from source to target:
Build InBound json value rules:
1 and 2 set inboundAdapterCallContext and status value: because field name ends with "$default", remove "$default" from field name, not change the value
3 set fullName value with: concat string full: with result.name value
4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].
URL Parameters:
JSON response body fields:
key: CustomerNumber
value: 5987953
{
"is_bank_id_exact_match":true,
"method_name":"getBank",
"connector_name":"rest_vMar2019",
"method_routing_id":"this-method-routing-Id",
"bank_id_pattern":"some_bankId",
"parameters":[{
"key":"url",
"value":"http://mydomain.com/xxx"
}]
}
-
CanUpdateMethodRouting
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-10021: Incorrect Connector name.
- OBP-10022: Incorrect Connector method name.
- OBP-50000: Unknown Error.