-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- Get API Info (root)
-
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- Create Account
- Create View
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank
- Get Accounts at all Banks (Private)
- Get all Accounts at all Banks
- Get private accounts at one bank
- Update Account Label
- Update View
-
-
Bank
-
A Bank (aka Space) represents a financial institution, brand or organizational unit under which resMore...
- Create Transaction Type at bank
- Get Bank
- Get Bank ATMS
- Get Banks
- Get Transaction Types at Bank
-
-
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 Consumer
- Get Consumers
- 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 Customer
- Create Customer Social Media Handle
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get Customers for Current User
- Get Customers for current User at Bank
-
-
Transaction
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- 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
-
User
-
The entity that accesses the API with a login / authorisation token and has access to zero or moreMore...
- Create User
- Get User (Current)
- Get Users by Email Address
- Get all Users
-
-
API
-
ATM
-
Account
- Create Account
- Create View
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank
- Get Accounts at all Banks (Private)
- Get all Accounts at all Banks
- Get private accounts at one bank
- Update Account Label
- Update View
-
Account Public
-
Bank
-
Branch
-
Card
-
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
- Create Customer
- Create Customer Social Media Handle
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get Customers for Current User
- Get Customers for current User at Bank
-
Customer Message
-
Data Warehouse
-
Documentation
-
Dynamic Resource Doc
-
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
-
Metric
-
Product
-
Role
- Add Entitlement for a User
- Delete Entitlement
- Get Entitlements for User
- Get Entitlements for User at Bank
- Get Roles
- Get all Entitlements
-
Sandbox
-
Transaction
- 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
-
User
-
View Custom
- 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
-
_Authority Data Request
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(000202)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(ADOPEM)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(APAP)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(BANRESERVAS)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(BHD LEON)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(CONFISA)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(POPULAR)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(SCOTIABANK)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Authority Data Request(brrd 01)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
-
_Foo Bar
-
_Obp Activity(trn.34.my.strings)
- Create new Obp Activity
- Delete Obp Activity by id
- Get Obp Activity List
- Get Obp Activity by id
- Update Obp Activity
v2.1.0 (194 APIs)
Create Branch
Create branch for the bank (Authenticated access).
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
bank_id: gh.29.uk
city:
country: Germany
id: d8839721-ad8f-45dd-9f78-2080414b93f9
latitude: 38.8951
longitude: -77.0364
meta:
name: ACCOUNT_MANAGEMENT_FEE
JSON response body fields:
city:
country: Germany
id: d8839721-ad8f-45dd-9f78-2080414b93f9
latitude: 38.8951
longitude: -77.0364
meta:
name: ACCOUNT_MANAGEMENT_FEE
scheme: scheme value
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"name":"String",
"address":{
"line_1":"Osloer Straße 16/17",
"line_2":"Wedding",
"line_3":"",
"city":"Berlin",
"state":"Berlin Brandenburg",
"postcode":"13359",
"country":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"lobby":{
"hours":"5"
},
"drive_up":{
"hours":"5"
},
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
},
"branch_routing":{
"scheme":"BranchNumber",
"address":"678"
}
}
-
CanCreateBranch
- 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-10001: Incorrect json format.
- 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:
Get Bank Branch
Returns information about branches for a single bank specified by BANK_ID and BRANCH_ID including:
meta.license.id and eta.license.name fields must not be empty.
- Name
- Address
- Geo Location
- License the data under this endpoint is released under
Authentication is Optional
URL Parameters:
BANK_ID: gh.29.uk
BRANCH_ID: DERBY6
JSON response body fields:
city:
country: Germany
id: d8839721-ad8f-45dd-9f78-2080414b93f9
latitude: 38.8951
longitude: -77.0364
meta:
name: ACCOUNT_MANAGEMENT_FEE
scheme: scheme value
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"name":"String",
"address":{
"line_1":"Osloer Straße 16/17",
"line_2":"Wedding",
"line_3":"",
"city":"Berlin",
"state":"Berlin Brandenburg",
"postcode":"13359",
"country":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"lobby":{
"hours":"5"
},
"drive_up":{
"hours":"5"
},
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
},
"branch_routing":{
"scheme":"BranchNumber",
"address":"678"
}
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 Bank Branches
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
Possible custom url parameters for pagination:
- limit=NUMBER ==> default value: 500
- offset=NUMBER ==> default value: 0
eg1:?limit=100&offset=0
- sort_direction=ASC/DESC ==> default value: DESC.
eg2:?limit=100&offset=0&sort_direction=ASC
You can use the url query parameters limit and offset for pagination
Authentication is Optional
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
city:
country: Germany
id: d8839721-ad8f-45dd-9f78-2080414b93f9
latitude: 38.8951
longitude: -77.0364
meta:
name: ACCOUNT_MANAGEMENT_FEE
scheme: scheme value
{
"branches":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"name":"String",
"address":{
"line_1":"Osloer Straße 16/17",
"line_2":"Wedding",
"line_3":"",
"city":"Berlin",
"state":"Berlin Brandenburg",
"postcode":"13359",
"country":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"lobby":{
"hours":"5"
},
"drive_up":{
"hours":"5"
},
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
},
"branch_routing":{
"scheme":"BranchNumber",
"address":"678"
}
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- No branches available. License may not be set.
- OBP-50000: Unknown Error.
Update Branch
Update an existing branch for a bank account (Authenticated access).
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
BRANCH_ID: DERBY6
JSON response body fields:
city:
country: Germany
id: d8839721-ad8f-45dd-9f78-2080414b93f9
latitude: 38.8951
longitude: -77.0364
meta:
name: ACCOUNT_MANAGEMENT_FEE
scheme: scheme value
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"name":"String",
"address":{
"line_1":"Osloer Straße 16/17",
"line_2":"Wedding",
"line_3":"",
"city":"Berlin",
"state":"Berlin Brandenburg",
"postcode":"13359",
"country":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"lobby":{
"hours":"5"
},
"drive_up":{
"hours":"5"
},
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
},
"branch_routing":{
"scheme":"BranchNumber",
"address":"678"
}
}
-
CanUpdateBranch
- 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-10001: Incorrect json format.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.