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
-
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
- Create Account Application
- Get Account Application by Id
- Get Account Applications
- Update Account Application Status
-
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
-
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
-
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
-
Consent
- Add User to a Consent
- Answer Consent Challenge
- Create Consent (EMAIL)
- Create Consent (SMS)
- Get Consents
- Revoke Consent
- Update Consent Status
-
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
-
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
-
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
- Get API Glossary
- Get Message Docs
- Get Message Docs Swagger
- Get Resource Docs
- Get Swagger documentation
- Get scanned API Versions
-
Dynamic Endpoint (Manage)
- Create Dynamic Endpoint
- Delete Dynamic Endpoint
- Get Dynamic Endpoint
- Get Dynamic Endpoints
- Delete My Dynamic Endpoint
- Get My Dynamic Endpoints
-
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
-
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
-
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
-
Method Routing
-
Metric
- Get Aggregate Metrics
- Get Connector Metrics
- Get Metrics
- Get Top APIs
- Get Top Consumers
- Search API Metrics via Elasticsearch
-
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
-
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
- 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
-
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
- 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
-
_TESTING
v4.0.0 (353 APIs)
Bank
Accounts
Views
Counterparties
Transactions
Create Branch
Create Branch for the Bank.
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON request body fields:
-
bank_id: gh.29.uk
-
is_accessible: true
-
latitude: 38.8951
-
longitude: -77.0364
JSON response body fields:
-
bank_id: gh.29.uk
-
is_accessible: true
-
latitude: 38.8951
-
longitude: -77.0364
{
"id":"branch-id-123",
"bank_id":"bank-id-123",
"name":"Branch by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"String",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":10.0,
"longitude":10.0
},
"meta":{
"license":{
"id":"PDDL",
"name":"Open Data Commons Public Domain Dedication and License "
}
},
"lobby":{
"monday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"tuesday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"wednesday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"thursday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"friday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"saturday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"sunday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}]
},
"drive_up":{
"monday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"tuesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"wednesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"thursday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"friday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"saturday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"sunday":{
"opening_time":"10:00",
"closing_time":"18:00"
}
},
"branch_routing":{
"scheme":"OBP",
"address":"123abc"
},
"is_accessible":"true",
"accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
"branch_type":"Full service store",
"more_info":"short walk to the lake from here",
"phone_number":"+381631954907"
}
-
CanCreateBranch
- Please login to request this Role
-
CanCreateBranchAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Delete Branch
{
"jsonString":"{}"
}
-
CanDeleteBranch
- Please login to request this Role
-
CanDeleteBranchAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30218: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Branch
Returns information about a single Branch specified by BANK_ID and BRANCH_ID including:
- Name
- Address
- Geo Location
- License the data under this endpoint is released under.
Authentication is Optional
URL Parameters:
JSON response body fields:
-
bank_id: gh.29.uk
-
is_accessible: true
-
latitude: 38.8951
-
longitude: -77.0364
{
"id":"branch-id-123",
"bank_id":"bank-id-123",
"name":"Branch by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"String",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":10.0,
"longitude":10.0
},
"meta":{
"license":{
"id":"PDDL",
"name":"Open Data Commons Public Domain Dedication and License "
}
},
"lobby":{
"monday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"tuesday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"wednesday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"thursday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"friday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"saturday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"sunday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}]
},
"drive_up":{
"monday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"tuesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"wednesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"thursday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"friday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"saturday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"sunday":{
"opening_time":"10:00",
"closing_time":"18:00"
}
},
"branch_routing":{
"scheme":"OBP",
"address":"123abc"
},
"is_accessible":"true",
"accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
"branch_type":"Full service store",
"more_info":"short walk to the lake from here",
"phone_number":"+381631954907"
}
- OBP-300010: Branch not found. Please specify a valid value for BRANCH_ID. Or License may not be set. meta.license.id and meta.license.name can not be empty
- OBP-50000: Unknown Error.
Get Branches for a Bank
Returns information about branches for a single bank specified by BANK_ID including:
- Name
- Address
- Geo Location
- License the data under this endpoint is released under
- Structured opening hours
- Accessible flag
- Branch Type
- More Info
Pagination:
By default, 50 records are returned.
You can use the url query parameters limit and offset for pagination
You can also use the follow url query parameters:
-
city - string, find Branches those in this city, optional
-
withinMetersOf - number, find Branches within given meters distance, optional
- nearLatitude - number, a position of latitude value, cooperate with withMetersOf do query filter, optional
- nearLongitude - number, a position of longitude value, cooperate with withMetersOf do query filter, optional
note: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value.
Authentication is Optional
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
bank_id: gh.29.uk
-
is_accessible: true
-
latitude: 38.8951
-
longitude: -77.0364
{
"branches":[{
"id":"branch-id-123",
"bank_id":"bank-id-123",
"name":"Branch by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"String",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":10.0,
"longitude":10.0
},
"meta":{
"license":{
"id":"PDDL",
"name":"Open Data Commons Public Domain Dedication and License "
}
},
"lobby":{
"monday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"tuesday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"wednesday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"thursday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"friday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"saturday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"sunday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}]
},
"drive_up":{
"monday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"tuesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"wednesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"thursday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"friday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"saturday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"sunday":{
"opening_time":"10:00",
"closing_time":"18:00"
}
},
"branch_routing":{
"scheme":"OBP",
"address":"123abc"
},
"is_accessible":"true",
"accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
"branch_type":"Full service store",
"more_info":"short walk to the lake from here",
"phone_number":"+381631954907"
}]
}
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-32001: No branches available. License may not be set.
- OBP-50000: Unknown Error.