-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- Create Bank Level Endpoint Tag
- Create System Level Endpoint Tag
- Delete Bank Level Endpoint Tag
- Delete System Level Endpoint Tag
- Get API Info (root)
- Get Bank Level Endpoint Tags
- Get Mapper Database Info
- Get System Level Endpoint Tags
- Get the Call Context of a current call
- Update Bank Level Endpoint Tag
- Update System Level Endpoint Tag
- Verify Request and Sign Response of a current call
-
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- Create Account (POST)
- Create or Update Account Attribute Definition
- Delete Account Attribute Definition
- Delete Account Cascade
- Get Account Attribute Definition
- Get Account Balances
- Get Account by Account Routing
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Balances
- Get Accounts Minimal for a Customer
- Get Accounts at Bank
- Get Accounts by Account Routing Regex
- Get Fast Firehose Accounts at Bank
- Get Firehose Accounts at Bank
- Update Account Label
- Validate and check IBAN
-
-
Account Access
-
Account Access governs access to Bank Accounts by end Users. It is an intersecting entity between tMore...
- Create (DAuth) User with Account Access
- Grant User access to View
- Revoke User access to View
- Revoke/Grant User access to View
-
-
Api Collection
- Create My Api Collection
- Create My Api Collection Endpoint
- Create My Api Collection Endpoint By Id
- Delete My Api Collection
- Delete My Api Collection Endpoint
- Delete My Api Collection Endpoint By Id
- Delete My Api Collection Endpoint By Id
- Get Api Collection Endpoints
- Get Api Collections for User
- Get Featured Api Collections
- Get My Api Collection By Id
- Get My Api Collection By Name
- Get My Api Collection Endpoint
- Get My Api Collection Endpoints
- Get My Api Collection Endpoints By Id
- Get My Api Collections
- Get Sharable Api Collection By Id
-
Bank
-
A Bank (aka Space) represents a financial institution, brand or organizational unit under which resMore...
- Create Bank
- Create Bank Attribute
- Create Settlement Account
- Create or Update Bank Attribute Definition
- Delete Bank Attribute
- Delete Bank Cascade
- Get Bank
- Get Bank Attribute By BANK_ATTRIBUTE_ID
- Get Bank Attributes
- Get Settlement accounts at Bank
- Update Bank Attribute
-
-
Connector Method
-
Developers can override all the existing Connector methods. This function needs to be used togethMore...
- Create Connector Method
- Get Connector Method by Id
- Get all Connector Methods
- Update Connector Method
-
-
Consent
-
Consents provide a mechanism by which a third party App or User can access resources on behalf of aMore...
- Add User to a Consent
- Get Consents
- Get Consents Info
- Update Consent Status
-
-
Consumer
-
The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on beMore...
- Post a Consumer
- Set Rate Limits / Call Limits per Consumer
-
-
Counterparty
- Create Counterparty (Explicit)
- Create Counterparty for any account (Explicit)
- Delete Counterparty (Explicit)
- Delete Counterparty for any account (Explicit)
- Get Counterparties (Explicit)
- Get Counterparties for any account (Explicit)
- Get Counterparty by Id (Explicit)
- Get Counterparty by Id for any account (Explicit)
- Get Counterparty by name for any account (Explicit)
-
Customer
-
The legal entity that has the relationship to the bank. Customers are linked to Users via `User CusMore...
- Create Customer
- Create Customer Attribute
- Create User Customer Link
- Create or Update Customer Attribute Definition
- Delete Customer Attribute
- Delete Customer Attribute Definition
- Delete Customer Cascade
- Delete User Customer Link
- Get Correlated Entities for the current User
- Get Correlated User Info by Customer
- Get Customer Attribute By Id
- Get Customer Attribute Definition
- Get Customer Attributes
- Get Customers Minimal at Any Bank
- Get Customers at Any Bank
- Get Customers by ATTRIBUTES
- Get Customers by MOBILE_PHONE_NUMBER
- Get User Customer Links by Customer
- Get User Customer Links by User
- Update Customer Attribute
-
-
Dynamic Endpoint Manage
-
If you want to create endpoints from Swagger / Open API specification files, use Dynamic EndpointsMore...
- Delete Bank Level Dynamic Endpoint
- Delete Dynamic Endpoint
- Get Bank Level Dynamic Endpoint
- Get Dynamic Endpoints
- Update Bank Level Dynamic Endpoint Host
- Update Dynamic Endpoint Host
- Create Bank Level Dynamic Endpoint
- Create Dynamic Endpoint
- Delete My Dynamic Endpoint
- Get Bank Level Dynamic Endpoints
- Get Dynamic Endpoint
- Get My Dynamic Endpoints
-
-
Dynamic Entity Manage
-
Dynamic Entities can be used to store and retrieve custom data objects (think your own tables andMore...
- Create Bank Level Dynamic Entity
- Create System Level Dynamic Entity
- Delete Bank Level Dynamic Entity
- Delete My Dynamic Entity
- Delete System Level Dynamic Entity
- Get Bank Level Dynamic Entities
- Get My Dynamic Entities
- Get System Dynamic Entities
- Update Bank Level Dynamic Entity
- Update My Dynamic Entity
- Update System Level Dynamic Entity
-
-
Dynamic Message Doc
-
In OBP we represent messages sent by a Connector method / function as MessageDocs. A MessageDoc dMore...
- Create Bank Level Dynamic Message Doc
- Create Dynamic Message Doc
- Delete Bank Level Dynamic Message Doc
- Delete Dynamic Message Doc
- Get Bank Level Dynamic Message Doc
- Get Dynamic Message Doc
- Get all Bank Level Dynamic Message Docs
- Get all Dynamic Message Docs
- Update Bank Level Dynamic Message Doc
- Update Dynamic Message Doc
-
-
Dynamic Resource Doc
- A test endpoint
- Create Bank Level Dynamic Resource Doc
- Create Dynamic Resource Doc
- Create Dynamic Resource Doc endpoint code
- Delete Bank Level Dynamic Resource Doc
- Delete Dynamic Resource Doc
- Get Bank Level Dynamic Resource Doc by Id
- Get Dynamic Resource Doc by Id
- Get all Bank Level Dynamic Resource Docs
- Get all Dynamic Resource Docs
- Update Bank Level Dynamic Resource Doc
- Update Dynamic Resource Doc
-
Endpoint Mapping
-
Endpoint Mapping can be used to map each JSON field in a Dynamic Endpoint to different Dynamic EntiMore...
- Create Bank Level Endpoint Mapping
- Create Endpoint Mapping
- Delete Bank Level Endpoint Mapping
- Delete Endpoint Mapping
- Get Bank Level Endpoint Mapping
- Get Endpoint Mapping by Id
- Get all Bank Level Endpoint Mappings
- Get all Endpoint Mappings
- Update Bank Level Endpoint Mapping
- Update Endpoint Mapping
-
-
JSON Schema Validation
-
JSON Schema is "a vocabulary that allows you to annotate and validate JSON documents". By applyinMore...
- Create a JSON Schema Validation
- Delete a JSON Schema Validation
- Get a JSON Schema Validation
- Get all JSON Schema Validations
- Get all JSON Schema Validations - public
- Update a JSON Schema Validation
-
-
Product
- Create Product
- Create Product Attribute
- Create Product Fee
- Create or Update Product Attribute Definition
- Delete Product Attribute Definition
- Delete Product Cascade
- Delete Product Fee
- Get Bank Product
- Get Product Attribute
- Get Product Attribute Definition
- Get Product Fee
- Get Product Fees
- Get Products
- Update Product Attribute
- Update Product Fee
-
Transaction
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- Create Transaction Attribute
- Create or Update Transaction Attribute Definition
- Delete Transaction Attribute Definition
- Delete Transaction Cascade
- Get Balancing Transaction
- Get Double Entry Transaction
- Get Transaction Attribute By Id
- Get Transaction Attribute Definition
- Get Transaction Attributes
- Update Transaction Attribute
-
-
Transaction Request
- Answer Transaction Request Challenge
- Create Historical Transactions
- Create Transaction Request (ACCOUNT)
- Create Transaction Request (ACCOUNT_OTP)
- Create Transaction Request (CARD)
- Create Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (REFUND)
- Create Transaction Request (SEPA)
- Create Transaction Request (SIMPLE)
- 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
- Update Transaction Request Attribute
-
User
-
The entity that accesses the API with a login / authorisation token and has access to zero or moreMore...
- Create My Personal User Attribute
- Create password reset url
- Delete a User
- Get Logout Link
- Get My Personal User Attributes
- Get My Spaces
- Get User Id (Current)
- Get User by USERNAME
- Get User by USER_ID
- Get User with Attributes by USER_ID
- Get Users by Email Address
- Get all Users
- Lock the user
- Update My Personal User Attribute
-
-
API
- Create Bank Level Endpoint Tag
- Create System Level Endpoint Tag
- Delete Bank Level Endpoint Tag
- Delete System Level Endpoint Tag
- Get API Info (root)
- Get Bank Level Endpoint Tags
- Get Mapper Database Info
- Get System Level Endpoint Tags
- Get the Call Context of a current call
- Update Bank Level Endpoint Tag
- Update System Level Endpoint Tag
- Verify Request and Sign Response of a current call
-
ATM
- Create ATM
- Delete ATM
- Get Bank ATM
- Get Bank ATMS
- UPDATE ATM
- Update ATM Accessibility Features
- Update ATM Location Categories
- Update ATM Notes
- Update ATM Services
- Update ATM Supported Currencies
- Update ATM Supported Languages
-
Account
- Create Account (POST)
- Create or Update Account Attribute Definition
- Delete Account Attribute Definition
- Delete Account Cascade
- Get Account Attribute Definition
- Get Account Balances
- Get Account by Account Routing
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Balances
- Get Accounts Minimal for a Customer
- Get Accounts at Bank
- Get Accounts by Account Routing Regex
- Get Fast Firehose Accounts at Bank
- Get Firehose Accounts at Bank
- Update Account Label
- Validate and check IBAN
-
Account Access
- Create (DAuth) User with Account Access
- Grant User access to View
- Revoke User access to View
- Revoke/Grant User access to View
-
Account Metadata
-
Api Collection
- Create My Api Collection
- Create My Api Collection Endpoint
- Create My Api Collection Endpoint By Id
- Delete My Api Collection
- Delete My Api Collection Endpoint
- Delete My Api Collection Endpoint By Id
- Delete My Api Collection Endpoint By Id
- Get Api Collection Endpoints
- Get Api Collections for User
- Get Featured Api Collections
- Get My Api Collection By Id
- Get My Api Collection By Name
- Get My Api Collection Endpoint
- Get My Api Collection Endpoints
- Get My Api Collection Endpoints By Id
- Get My Api Collections
- Get Sharable Api Collection By Id
-
Authentication Type Validation
- Create an Authentication Type Validation
- Delete an Authentication Type Validation
- Get all Authentication Type Validations
- Get all Authentication Type Validations - public
- Get an Authentication Type Validation
- Update an Authentication Type Validation
-
Bank
- Create Bank
- Create Bank Attribute
- Create Settlement Account
- Create or Update Bank Attribute Definition
- Delete Bank Attribute
- Delete Bank Cascade
- Get Bank
- Get Bank Attribute By BANK_ATTRIBUTE_ID
- Get Bank Attributes
- Get Settlement accounts at Bank
- Update Bank Attribute
-
Bank Accounts (Dynamic Endpoint)
-
BankAccountTag1
-
Card
- Create or Update Card Attribute Definition
- Delete Card Attribute Definition
- Get Card Attribute Definition
-
Connector Method
- Create Connector Method
- Get Connector Method by Id
- Get all Connector Methods
- Update Connector Method
-
Consent
-
Consumer
-
Counterparty
- Create Counterparty (Explicit)
- Create Counterparty for any account (Explicit)
- Delete Counterparty (Explicit)
- Delete Counterparty for any account (Explicit)
- Get Counterparties (Explicit)
- Get Counterparties for any account (Explicit)
- Get Counterparty by Id (Explicit)
- Get Counterparty by Id for any account (Explicit)
- Get Counterparty by name for any account (Explicit)
-
Customer
- Create Customer
- Create Customer Attribute
- Create User Customer Link
- Create or Update Customer Attribute Definition
- Delete Customer Attribute
- Delete Customer Attribute Definition
- Delete Customer Cascade
- Delete User Customer Link
- Get Correlated Entities for the current User
- Get Correlated User Info by Customer
- Get Customer Attribute By Id
- Get Customer Attribute Definition
- Get Customer Attributes
- Get Customers Minimal at Any Bank
- Get Customers at Any Bank
- Get Customers by ATTRIBUTES
- Get Customers by MOBILE_PHONE_NUMBER
- Get User Customer Links by Customer
- Get User Customer Links by User
- Update Customer Attribute
-
Customer Message
-
Direct Debit
-
Documentation
-
Dynamic Endpoint Manage
- Delete Bank Level Dynamic Endpoint
- Delete Dynamic Endpoint
- Get Bank Level Dynamic Endpoint
- Get Dynamic Endpoints
- Update Bank Level Dynamic Endpoint Host
- Update Dynamic Endpoint Host
- Create Bank Level Dynamic Endpoint
- Create Dynamic Endpoint
- Delete My Dynamic Endpoint
- Get Bank Level Dynamic Endpoints
- Get Dynamic Endpoint
- Get My Dynamic Endpoints
-
Dynamic Entity Manage
- Create Bank Level Dynamic Entity
- Create System Level Dynamic Entity
- Delete Bank Level Dynamic Entity
- Delete My Dynamic Entity
- Delete System Level Dynamic Entity
- Get Bank Level Dynamic Entities
- Get My Dynamic Entities
- Get System Dynamic Entities
- Update Bank Level Dynamic Entity
- Update My Dynamic Entity
- Update System Level Dynamic Entity
-
Dynamic Message Doc
- Create Bank Level Dynamic Message Doc
- Create Dynamic Message Doc
- Delete Bank Level Dynamic Message Doc
- Delete Dynamic Message Doc
- Get Bank Level Dynamic Message Doc
- Get Dynamic Message Doc
- Get all Bank Level Dynamic Message Docs
- Get all Dynamic Message Docs
- Update Bank Level Dynamic Message Doc
- Update Dynamic Message Doc
-
Dynamic Resource Doc
- A test endpoint
- Create Bank Level Dynamic Resource Doc
- Create Dynamic Resource Doc
- Create Dynamic Resource Doc endpoint code
- Delete Bank Level Dynamic Resource Doc
- Delete Dynamic Resource Doc
- Get Bank Level Dynamic Resource Doc by Id
- Get Dynamic Resource Doc by Id
- Get all Bank Level Dynamic Resource Docs
- Get all Dynamic Resource Docs
- Update Bank Level Dynamic Resource Doc
- Update Dynamic Resource Doc
-
Endpoint Mapping
- Create Bank Level Endpoint Mapping
- Create Endpoint Mapping
- Delete Bank Level Endpoint Mapping
- Delete Endpoint Mapping
- Get Bank Level Endpoint Mapping
- Get Endpoint Mapping by Id
- Get all Bank Level Endpoint Mappings
- Get all Endpoint Mappings
- Update Bank Level Endpoint Mapping
- Update Endpoint Mapping
-
JSON Schema Validation
- Create a JSON Schema Validation
- Delete a JSON Schema Validation
- Get a JSON Schema Validation
- Get all JSON Schema Validations
- Get all JSON Schema Validations - public
- Update a JSON Schema Validation
-
Product
- Create Product
- Create Product Attribute
- Create Product Fee
- Create or Update Product Attribute Definition
- Delete Product Attribute Definition
- Delete Product Cascade
- Delete Product Fee
- Get Bank Product
- Get Product Attribute
- Get Product Attribute Definition
- Get Product Fee
- Get Product Fees
- Get Products
- Update Product Attribute
- Update Product Fee
-
Role
-
Scope
-
Standing Order
-
Transaction
- Create Transaction Attribute
- Create or Update Transaction Attribute Definition
- Delete Transaction Attribute Definition
- Delete Transaction Cascade
- Get Balancing Transaction
- Get Double Entry Transaction
- Get Transaction Attribute By Id
- Get Transaction Attribute Definition
- Get Transaction Attributes
- Update Transaction Attribute
-
Transaction Request
- Answer Transaction Request Challenge
- Create Historical Transactions
- Create Transaction Request (ACCOUNT)
- Create Transaction Request (ACCOUNT_OTP)
- Create Transaction Request (CARD)
- Create Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (REFUND)
- Create Transaction Request (SEPA)
- Create Transaction Request (SIMPLE)
- 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
- Update Transaction Request Attribute
-
User
- Create My Personal User Attribute
- Create password reset url
- Delete a User
- Get Logout Link
- Get My Personal User Attributes
- Get My Spaces
- Get User Id (Current)
- Get User by USERNAME
- Get User by USER_ID
- Get User with Attributes by USER_ID
- Get Users by Email Address
- Get all Users
- Lock the user
- Update My Personal User Attribute
-
User Invitation
-
Webhook
-
_Covid APIDays
- Create new Covid APIDays
- Delete Covid APIDays by id
- Get Covid APIDays List
- Get Covid APIDays by id
- Update Covid APIDays
-
_Customer Cars
- Create new Customer Cars
- Delete Customer Cars by id
- Get Customer Cars List
- Get Customer Cars by id
- Update Customer Cars
-
_D Entity1(gh.29.uk)
-
_Fish Port
-
_Foo Bar
-
_Insurance Policy(gh.29.uk)
- Create new Insurance Policy
- Delete Insurance Policy by id
- Get Insurance Policy List
- Get Insurance Policy by id
- Update Insurance Policy
-
_Insurance Premium(gh.29.uk)
- Create new Insurance Premium
- Delete Insurance Premium by id
- Get Insurance Premium List
- Get Insurance Premium by id
- Update Insurance Premium
-
_March Hare(gh.29.uk)
- Create new March Hare
- Delete March Hare by id
- Get March Hare List
- Get March Hare by id
- Update March Hare
-
_Obp Activity(obp.testing.01)
- Create new Obp Activity
- Delete Obp Activity by id
- Get Obp Activity List
- Get Obp Activity by id
- Update Obp Activity
-
_Odometer(gh.29.uk)
-
_Simon Covid
- Create new Simon Covid
- Delete Simon Covid by id
- Get Simon Covid List
- Get Simon Covid by id
- Update Simon Covid
-
_Sustrans
-
_Test Daniel707
- Create new My Test Daniel707
- Create new Test Daniel707
- Delete My Test Daniel707 by id
- Delete Test Daniel707 by id
- Get My Test Daniel707 List
- Get My Test Daniel707 by id
- Get Test Daniel707 List
- Get Test Daniel707 by id
- Update My Test Daniel707
- Update Test Daniel707
-
_Test1
v4.0.0 (those added or modified in this version) (337 APIs)
Create Bank Level Endpoint Tag
Create Bank Level Endpoint Tag
Note: Resource Docs are cached, TTL is 3600 seconds
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
OPERATION_ID: OBPv4.0.0-getBanks
JSON request body fields:
tag_name: BankAccountTag1
JSON response body fields:
bank_id: gh.29.uk
endpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
operation_id: OBPv4.0.0-getBanks
tag_name: BankAccountTag1
{
"bank_id":"gh.29.uk",
"endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"operation_id":"OBPv4.0.0-getBanks",
"tag_name":"BankAccountTag1"
}
-
CanCreateBankLevelEndpointTag
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Create System Level Endpoint Tag
Create System Level Endpoint Tag
Note: Resource Docs are cached, TTL is 3600 seconds
Authentication is Mandatory
URL Parameters:
OPERATION_ID: OBPv4.0.0-getBanks
JSON request body fields:
tag_name: BankAccountTag1
JSON response body fields:
bank_id: gh.29.uk
endpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
operation_id: OBPv4.0.0-getBanks
tag_name: BankAccountTag1
{
"bank_id":"gh.29.uk",
"endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"operation_id":"OBPv4.0.0-getBanks",
"tag_name":"BankAccountTag1"
}
-
CanCreateSystemLevelEndpointTag
- 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-50000: Unknown Error.
Delete Bank Level Endpoint Tag
Delete Bank Level Endpoint Tag.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
ENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
OPERATION_ID: OBPv4.0.0-getBanks
JSON response body fields:
true
-
CanDeleteBankLevelEndpointTag
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Delete System Level Endpoint Tag
Delete System Level Endpoint Tag.
Authentication is Mandatory
URL Parameters:
ENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
OPERATION_ID: OBPv4.0.0-getBanks
JSON response body fields:
true
-
CanDeleteSystemLevelEndpointTag
- 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 API Info (root)
Returns information about:
- API version
- Hosted by information
- Hosted at information
- Energy source information
- Git Commit
Authentication is Optional
JSON response body fields:
connector: connector
git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
hostname: hostname
local_identity_provider: local_identity_provider
resource_docs_requires_role: resource_docs_requires_role
{
"version":"String",
"version_status":"String",
"git_commit":"String",
"connector":"String",
"hostname":"String",
"local_identity_provider":"String",
"hosted_by":{
"organisation":"String",
"email":"String",
"phone":"String",
"organisation_website":"String"
},
"hosted_at":{
"organisation":"Amazon",
"organisation_website":"https://aws.amazon.com/"
},
"energy_source":{
"organisation":"Stromio",
"organisation_website":"https://www.stromio.de/"
},
"resource_docs_requires_role":false
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
- no connector set
Get Bank Level Endpoint Tags
Get Bank Level Endpoint Tags.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
OPERATION_ID: OBPv4.0.0-getBanks
JSON response body fields:
bank_id: gh.29.uk
endpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
operation_id: OBPv4.0.0-getBanks
tag_name: BankAccountTag1
[{
"bank_id":"gh.29.uk",
"endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"operation_id":"OBPv4.0.0-getBanks",
"tag_name":"BankAccountTag1"
}]
-
CanGetBankLevelEndpointTag
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Mapper Database Info
Get basic information about the Mapper Database.
Authentication is Mandatory
JSON response body fields:
date: 2020-01-27
git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
name: ACCOUNT_MANAGEMENT_FEE
{
"name":"String",
"version":"String",
"git_commit":"String",
"date":"2013-01-21T23:08:00Z"
}
-
CanGetDatabaseInfo
- 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-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get System Level Endpoint Tags
Get System Level Endpoint Tags.
Authentication is Mandatory
URL Parameters:
OPERATION_ID: OBPv4.0.0-getBanks
JSON response body fields:
bank_id: gh.29.uk
endpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
operation_id: OBPv4.0.0-getBanks
tag_name: BankAccountTag1
[{
"bank_id":"gh.29.uk",
"endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"operation_id":"OBPv4.0.0-getBanks",
"tag_name":"BankAccountTag1"
}]
-
CanGetSystemLevelEndpointTag
- 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 the Call Context of a current call
Get the Call Context of the current call.
Authentication is Mandatory
JSON response body fields:
-
CanGetCallContext
- 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-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Update Bank Level Endpoint Tag
Update Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.
Note: Resource Docs are cached, TTL is 3600 seconds
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
ENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
OPERATION_ID: OBPv4.0.0-getBanks
JSON response body fields:
bank_id: gh.29.uk
endpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
operation_id: OBPv4.0.0-getBanks
tag_name: BankAccountTag1
{
"bank_id":"gh.29.uk",
"endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"operation_id":"OBPv4.0.0-getBanks",
"tag_name":"BankAccountTag1"
}
-
CanUpdateBankLevelEndpointTag
- 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-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20006: User is missing one or more roles:
- OBP-30099: Invalid ENDPOINT_TAG_ID. Please specify a valid value for ENDPOINT_TAG_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Update System Level Endpoint Tag
Update System Level Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.
Note: Resource Docs are cached, TTL is 3600 seconds
Authentication is Mandatory
URL Parameters:
ENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
OPERATION_ID: OBPv4.0.0-getBanks
JSON response body fields:
bank_id: gh.29.uk
endpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
operation_id: OBPv4.0.0-getBanks
tag_name: BankAccountTag1
{
"bank_id":"gh.29.uk",
"endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"operation_id":"OBPv4.0.0-getBanks",
"tag_name":"BankAccountTag1"
}
-
CanUpdateSystemLevelEndpointTag
- 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-30099: Invalid ENDPOINT_TAG_ID. Please specify a valid value for ENDPOINT_TAG_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Verify Request and Sign Response of a current call
Verify Request and Sign Response of a current call.
Authentication is Mandatory
JSON response body fields:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.