-
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 Configuration
- Get API Info (root)
- Get Adapter Info
- Get Adapter Info for a bank
- Get Bank Level Endpoint Tags
- Get Connector Status (Loopback)
- Get JSON Web Key (JWK)
- Get JSON Web Key (JWK) URIs
- Get Mapper Database Info
- Get Rate Limiting 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...
- 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 Balances
- Get Account by Account Routing
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Balances
- Get Accounts Held
- Get Accounts Minimal for a Customer
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Accounts by Account Routing Regex
- Get Checkbook orders
- Get Fast Firehose Accounts at Bank
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
- Validate and check IBAN number
-
-
Account Access
-
Account Access is OBP View system. The Account owners can create the view themselves. And they canMore...
- Create (DAuth) User with Account Access
- Grant User access to View
- Revoke 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
- 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 Banks
- Get Settlement accounts at Bank
- Get Transaction Types at Bank
- Update Bank Attribute
-
-
Connector Method
-
The developer can override all the existing Connector methods on their own. This function needsMore...
- Create Connector Method
- Get Connector Method by Id
- Get all Connector Methods
- Update Connector Method
-
-
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)
- Post a Consumer
- Set Calls Limit for a Consumer
-
-
Counterparty Metadata
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url 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 Image Url
- Update Counterparty More Info
- 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 Credit Limit Order Request
- Create Customer
- Create Customer Attribute
- Create Tax Residence
- Create or Update Customer Attribute Definition
- Delete Customer Address
- Delete Customer Attribute
- Delete Customer Attribute Definition
- Delete Customer Cascade
- Delete Tax Residence
- Delete User Customer Link
- Get Correlated Entities for the current User
- Get Correlated User Info by Customer
- 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 by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers Minimal at Any Bank
- Get Customers at Any Bank
- 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
-
-
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 Dynamic Entity
- Delete Bank Level Dynamic Entity
- Delete Dynamic Entity
- Delete My Dynamic Entity
- Get Bank Level Dynamic Entities
- Get Dynamic Entities
- Get My Dynamic Entities
- Update Bank Level Dynamic Entity
- Update Dynamic Entity
- Update My Dynamic Entity
-
-
Dynamic Message Doc
-
The developers can create their own scala methods in OBP code. These endpoints are designed for eMore...
- 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
-
The developers can create their own endpoints by this endpoint. Need to prepare the obp resourceMore...
- 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 applyingMore...
- 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
-
-
Method Routing
-
Open Bank Project can have different connectors, to connect difference data sources. We supportMore...
- Create MethodRouting
- Delete MethodRouting
- Get MethodRoutings
- Update MethodRouting
-
-
Product
- Create Product
- Create Product Attribute
- Create Product Fee
- Create or Update Product Attribute Definition
- Delete Product Attribute
- 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 Product Tree
- Get Products
- Update Product Attribute
- Update Product Fee
-
Role
- Add Entitlement for a User
- Create (DAuth) User with Roles
- 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
-
Transaction
-
Records of successful movements of money from / to an `Account`. OBP Transactions don't contain anyMore...
- 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 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 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 Historical Transactions
- 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 (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
- Get Transaction Request Types at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
- Save Historical Transactions
- Update Transaction Request Attribute
-
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 Attribute for current user
- Create User Auth Context
- Create User Auth Context Update Request
- Create password reset url
- Delete User Auth Context
- Delete User's Auth Contexts
- Delete a User
- Get Logout Link
- Get My Spaces
- Get User (Current)
- Get User Attributes for current user
- Get User Attributes for the user
- Get User Auth Contexts
- Get User Id (Current)
- 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
- Update User Attribute for current user
-
-
API
-
Create Bank Level Endpoint Tag
-
Create System Level Endpoint Tag
-
Delete Bank Level Endpoint Tag
-
Delete System Level Endpoint Tag
-
Get API Configuration
-
Get API Info (root)
-
Get Adapter Info
-
Get Adapter Info for a bank
-
Get Bank Level Endpoint Tags
-
Get Connector Status (Loopback)
-
Get JSON Web Key (JWK)
-
Get JSON Web Key (JWK) URIs
-
Get Mapper Database Info
-
Get Rate Limiting 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
-
Create Bank Level Endpoint Tag
-
ATM
-
Create 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
-
Create 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 Balances
-
Get Account by Account Routing
-
Get Account by Id (Core)
-
Get Account by Id (Full)
-
Get Accounts Balances
-
Get Accounts Held
-
Get Accounts Minimal for a Customer
-
Get Accounts at Bank
-
Get Accounts at Bank (IDs only)
-
Get Accounts at Bank (Minimal)
-
Get Accounts at all Banks (private)
-
Get Accounts by Account Routing Regex
-
Get Checkbook orders
-
Get Fast Firehose Accounts at Bank
-
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
-
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
-
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
-
Create My Api Collection
-
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
-
Create 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 Banks
-
Get Settlement accounts at Bank
-
Get Transaction Types at Bank
-
Update Bank Attribute
-
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 status of Credit Card order
-
Update Card
-
Update Card Attribute
-
Create Card
-
Connector Method
-
Create Connector Method
-
Get Connector Method by Id
-
Get all Connector Methods
-
Update Connector Method
-
Create Connector Method
-
Consent
-
Add User to a Consent
-
Answer Consent Challenge
-
Create Consent (EMAIL)
-
Create Consent (SMS)
-
Get Consents
-
Get Consents Info
-
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
-
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 Counterparty More Info
-
Add Open Corporates URL to Counterparty
-
Add image url 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 Image Url
-
Update Counterparty More Info
-
Update Counterparty Private Alias
-
Update Open Corporates Url of Counterparty
-
Update public alias of other bank account
-
Update url of other bank account
-
Add Counterparty More Info
-
Customer
-
Create Address
-
Create Credit Limit Order Request
-
Create Customer
-
Create Customer Attribute
-
Create Tax Residence
-
Create or Update Customer Attribute Definition
-
Delete Customer Address
-
Delete Customer Attribute
-
Delete Customer Attribute Definition
-
Delete Customer Cascade
-
Delete Tax Residence
-
Delete User Customer Link
-
Get Correlated Entities for the current User
-
Get Correlated User Info by Customer
-
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 by CUSTOMER_ID
-
Get Customer by CUSTOMER_NUMBER
-
Get Customers Minimal at Any Bank
-
Get Customers at Any Bank
-
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
-
Create Address
-
Customer Meeting
-
Data Warehouse
-
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
-
Delete Bank Level Dynamic Endpoint
-
Dynamic Entity Manage
-
Create Bank Level Dynamic Entity
-
Create Dynamic Entity
-
Delete Bank Level Dynamic Entity
-
Delete Dynamic Entity
-
Delete My Dynamic Entity
-
Get Bank Level Dynamic Entities
-
Get Dynamic Entities
-
Get My Dynamic Entities
-
Update Bank Level Dynamic Entity
-
Update Dynamic Entity
-
Update My Dynamic Entity
-
Create Bank 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
-
Create Bank Level 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
-
A test endpoint
-
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
-
Create Bank Level Endpoint Mapping
-
FX
-
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
-
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
-
Product
-
Create Product
-
Create Product Attribute
-
Create Product Fee
-
Create or Update Product Attribute Definition
-
Delete Product Attribute
-
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 Product Tree
-
Get Products
-
Update Product Attribute
-
Update Product Fee
-
Create Product
-
Product Collection
-
Role
-
Add Entitlement for a User
-
Create (DAuth) User with Roles
-
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
-
Scope
-
Standing Order
-
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 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 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 Historical Transactions
-
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 (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
-
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 Attribute for current user
-
Create User Auth Context
-
Create User Auth Context Update Request
-
Create password reset url
-
Delete User Auth Context
-
Delete User's Auth Contexts
-
Delete a User
-
Get Logout Link
-
Get My Spaces
-
Get User (Current)
-
Get User Attributes for current user
-
Get User Attributes for the user
-
Get User Auth Contexts
-
Get User Id (Current)
-
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
-
Update User Attribute for current user
-
Answer Auth Context Update Challenge
-
User Invitation
-
View Custom
-
View System
-
WebUi Props
-
Webhook
-
Create an Account Webhook
-
Create bank level Account Notification Webhook
-
Create system level Account Notification Webhook
-
Enable/Disable an Account Webhook
-
Get Account Webhooks
-
Create an Account Webhook
-
_CovidAPIDays
-
Create new Covid APIDays
-
Delete Covid APIDays by id
-
Get Covid APIDays List
-
Get Covid APIDays by id
-
Update Covid APIDays
-
Create new 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
-
Create new Customer Cars
-
_D Entity1
-
_FishPort
-
_FooBar
-
_InsurancePolicy
-
Create new Insurance Policy
-
Delete Insurance Policy by id
-
Get Insurance Policy List
-
Get Insurance Policy by id
-
Update Insurance Policy
-
Create new Insurance Policy
-
_InsurancePremium
-
Create new Insurance Premium
-
Delete Insurance Premium by id
-
Get Insurance Premium List
-
Get Insurance Premium by id
-
Update Insurance Premium
-
Create new Insurance Premium
-
_MarchHare
-
Create new March Hare
-
Delete March Hare by id
-
Get March Hare List
-
Get March Hare by id
-
Update March Hare
-
Create new March Hare
-
_ObpActivity
-
Create new Obp Activity
-
Delete Obp Activity by id
-
Get Obp Activity List
-
Get Obp Activity by id
-
Update Obp Activity
-
Create new Obp Activity
-
_Odometer
-
_SimonCovid
-
Create new Simon Covid
-
Delete Simon Covid by id
-
Get Simon Covid List
-
Get Simon Covid by id
-
Update Simon Covid
-
Create new Simon Covid
-
_Sustrans
-
_Test1
v4.0.0 filtered by tag: New-Style (496 APIs)
Create Bank Level Endpoint Tag
Create Bank Level Endpoint Tag
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
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:
- value: 5987953
{
"value":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:
- value: 5987953
{
"value":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 Configuration
Returns information about:
- The default bank_id
- Akka configuration
- Elastic Search configuration
- Cached functions
Authentication is Mandatory
JSON response body fields:
-
value: 5987953
{
"akka":{
"ports":[{
"property":"default",
"value":"8080"
}],
"log_level":"Debug",
"remote_data_secret_matched":true
},
"elastic_search":{
"metrics":[{
"property":"String",
"value":"Mapper"
}],
"warehouse":[{
"property":"String",
"value":"ElasticSearch"
}]
},
"cache":[{
"function_name":"getBanks",
"ttl_in_seconds":5
}],
"scopes":{
"require_scopes_for_all_roles":true,
"require_scopes_for_listed_roles":["CanCreateUserAuthContextUpdate"]
}
}
-
CanGetConfig
- 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 Adapter Info
Get basic information about the Adapter.
Authentication is Optional
JSON response body fields:
-
[date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 2020-01-27
-
git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
-
name: ACCOUNT_MANAGEMENT_FEE
{
"name":"String",
"version":"String",
"git_commit":"String",
"date":"2013-01-21T23:08:00Z"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
Get Adapter Info for a bank
Get basic information about the Adapter listening on behalf of this bank.
Authentication is Optional
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
[date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 2020-01-27
-
git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
-
name: ACCOUNT_MANAGEMENT_FEE
{
"name":"String",
"version":"String",
"git_commit":"String",
"date":"2013-01-21T23:08:00Z"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
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 Connector Status (Loopback)
This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable.
Currently this is only implemented for Kafka based connectors.
For Kafka based connectors, this endpoint writes a message to Kafka and reads it again.
In the future, this endpoint may also return information about database connections etc.
Authentication is Mandatory
JSON response body fields:
-
duration_time: 60
-
git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
{
"connector_version":"kafka_vSept2018",
"git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0",
"duration_time":"10 ms"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
Get JSON Web Key (JWK)
Get the server's public JSON Web Key (JWK) set and certificate chain.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.
Authentication is Optional
JSON response body fields:
{
"kty":"RSA",
"e":"AQAB",
"use":"sig",
"kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s",
"n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
Get JSON Web Key (JWK) URIs
Get the OAuth2 server's public JSON Web Key (JWK) URIs.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.
Authentication is Optional
JSON response body fields:
{
"jwks_uris":[{
"jwks_uri":"https://www.googleapis.com/oauth2/v3/certs"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
Get Mapper Database Info
Get basic information about the Mapper Database.
Authentication is Mandatory
JSON response body fields:
-
[date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 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 Rate Limiting Info
{
"enabled":true,
"technology":"REDIS",
"service_available":true,
"is_active":true
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
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.
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.
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.
Create ATM
Create ATM.
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON request body fields:
-
accessibility_features: ["ATAC","ATAD"]
-
bank_id: gh.29.uk
-
branch_identification: branch_identification
-
closing_time: 2020-01-27
-
country_code: 1254
-
has_deposit_capability: true
-
is_accessible: true
-
latitude: 38.8951
-
location_categories: location_categories
-
longitude: -77.0364
-
minimum_withdrawal: minimum_withdrawal
-
name: ACCOUNT_MANAGEMENT_FEE
-
notes: notes
-
services: services
-
site_identification: site_identification
-
site_name: site_name
-
supported_currencies: ["EUR","MXN","USD"]
-
supported_languages: ["es","fr","de"]
JSON response body fields:
-
accessibility_features: ["ATAC","ATAD"]
-
bank_id: gh.29.uk
-
branch_identification: branch_identification
-
closing_time: 2020-01-27
-
country_code: 1254
-
has_deposit_capability: true
-
is_accessible: true
-
latitude: 38.8951
-
location_categories: location_categories
-
longitude: -77.0364
-
minimum_withdrawal: minimum_withdrawal
-
name: ACCOUNT_MANAGEMENT_FEE
-
notes: notes
-
services: services
-
site_identification: site_identification
-
site_name: site_name
-
supported_currencies: ["EUR","MXN","USD"]
-
supported_languages: ["es","fr","de"]
{
"id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
"bank_id":"gh.29.uk",
"name":"Atm by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
},
"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"
},
"is_accessible":"true",
"located_at":"no-example-provided",
"more_info":"no-example-provided",
"has_deposit_capability":"true",
"supported_languages":["es","fr","de"],
"services":["ATBP","ATBA"],
"accessibility_features":["ATAC","ATAD"],
"supported_currencies":["EUR","MXN","USD"],
"notes":["String1","String2"],
"location_categories":["ATBI","ATBE"],
"minimum_withdrawal":"5",
"branch_identification":"no-example-provided",
"site_identification":"no-example-provided",
"site_name":"no-example-provided",
"cash_withdrawal_national_fee":"no-example-provided",
"cash_withdrawal_international_fee":"no-example-provided",
"balance_inquiry_fee":"no-example-provided"
}
-
CanCreateAtm
- Please login to request this Role
-
CanCreateAtmAtAnyBank
- 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-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Bank ATM
Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:
- Address
- Geo Location
- License the data under this endpoint is released under
Authentication is Optional
URL Parameters:
JSON response body fields:
-
accessibility_features: ["ATAC","ATAD"]
-
bank_id: gh.29.uk
-
branch_identification: branch_identification
-
closing_time: 2020-01-27
-
country_code: 1254
-
has_deposit_capability: true
-
is_accessible: true
-
latitude: 38.8951
-
location_categories: location_categories
-
longitude: -77.0364
-
minimum_withdrawal: minimum_withdrawal
-
name: ACCOUNT_MANAGEMENT_FEE
-
notes: notes
-
services: services
-
site_identification: site_identification
-
site_name: site_name
-
supported_currencies: ["EUR","MXN","USD"]
-
supported_languages: ["es","fr","de"]
{
"id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
"bank_id":"gh.29.uk",
"name":"Atm by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
},
"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"
},
"is_accessible":"true",
"located_at":"no-example-provided",
"more_info":"no-example-provided",
"has_deposit_capability":"true",
"supported_languages":["es","fr","de"],
"services":["ATBP","ATBA"],
"accessibility_features":["ATAC","ATAD"],
"supported_currencies":["EUR","MXN","USD"],
"notes":["String1","String2"],
"location_categories":["ATBI","ATBE"],
"minimum_withdrawal":"5",
"branch_identification":"no-example-provided",
"site_identification":"no-example-provided",
"site_name":"no-example-provided",
"cash_withdrawal_national_fee":"no-example-provided",
"cash_withdrawal_international_fee":"no-example-provided",
"balance_inquiry_fee":"no-example-provided"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Get Bank ATMS
Get Bank ATMS.
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
accessibility_features: ["ATAC","ATAD"]
-
bank_id: gh.29.uk
-
branch_identification: branch_identification
-
closing_time: 2020-01-27
-
country_code: 1254
-
has_deposit_capability: true
-
is_accessible: true
-
latitude: 38.8951
-
location_categories: location_categories
-
longitude: -77.0364
-
minimum_withdrawal: minimum_withdrawal
-
name: ACCOUNT_MANAGEMENT_FEE
-
notes: notes
-
services: services
-
site_identification: site_identification
-
site_name: site_name
-
supported_currencies: ["EUR","MXN","USD"]
-
supported_languages: ["es","fr","de"]
{
"atms":[{
"id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
"bank_id":"gh.29.uk",
"name":"Atm by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
},
"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"
},
"is_accessible":"true",
"located_at":"no-example-provided",
"more_info":"no-example-provided",
"has_deposit_capability":"true",
"supported_languages":["es","fr","de"],
"services":["ATBP","ATBA"],
"accessibility_features":["ATAC","ATAD"],
"supported_currencies":["EUR","MXN","USD"],
"notes":["String1","String2"],
"location_categories":["ATBI","ATBE"],
"minimum_withdrawal":"5",
"branch_identification":"no-example-provided",
"site_identification":"no-example-provided",
"site_name":"no-example-provided",
"cash_withdrawal_national_fee":"no-example-provided",
"cash_withdrawal_international_fee":"no-example-provided",
"balance_inquiry_fee":"no-example-provided"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
UPDATE ATM
Update ATM.
Authentication is Mandatory
URL Parameters:
JSON response body fields:
-
accessibility_features: ["ATAC","ATAD"]
-
bank_id: gh.29.uk
-
branch_identification: branch_identification
-
closing_time: 2020-01-27
-
country_code: 1254
-
has_deposit_capability: true
-
is_accessible: true
-
latitude: 38.8951
-
location_categories: location_categories
-
longitude: -77.0364
-
minimum_withdrawal: minimum_withdrawal
-
name: ACCOUNT_MANAGEMENT_FEE
-
notes: notes
-
services: services
-
site_identification: site_identification
-
site_name: site_name
-
supported_currencies: ["EUR","MXN","USD"]
-
supported_languages: ["es","fr","de"]
{
"id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
"bank_id":"gh.29.uk",
"name":"Atm by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"meta":{
"license":{
"id":"ODbL-1.0",
"name":"Open Database License"
}
},
"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"
},
"is_accessible":"true",
"located_at":"no-example-provided",
"more_info":"no-example-provided",
"has_deposit_capability":"true",
"supported_languages":["es","fr","de"],
"services":["ATBP","ATBA"],
"accessibility_features":["ATAC","ATAD"],
"supported_currencies":["EUR","MXN","USD"],
"notes":["String1","String2"],
"location_categories":["ATBI","ATBE"],
"minimum_withdrawal":"5",
"branch_identification":"no-example-provided",
"site_identification":"no-example-provided",
"site_name":"no-example-provided",
"cash_withdrawal_national_fee":"no-example-provided",
"cash_withdrawal_international_fee":"no-example-provided",
"balance_inquiry_fee":"no-example-provided"
}
-
CanUpdateAtm
- Please login to request this Role
-
CanUpdateAtmAtAnyBank
- 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-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Update ATM Accessibility Features
Update ATM Accessibility Features.
Authentication is Mandatory
URL Parameters:
JSON response body fields:
-
accessibility_features: ["ATAC","ATAD"]
-
atm_id: atme0352a-9a0f-4bfa-b30b-9003aa467f51
{
"atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
"accessibility_features":["ATAC","ATAD"]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Update ATM Location Categories
Update ATM Location Categories.
Authentication is Mandatory
URL Parameters:
JSON response body fields:
-
atm_id: atme0352a-9a0f-4bfa-b30b-9003aa467f51
-
location_categories: location_categories
{
"atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
"location_categories":["ATBI","ATBE"]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Update ATM Notes
{
"atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
"notes":["String1","String2"]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Update ATM Services
{
"atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
"services":["ATBP","ATBA"]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Update ATM Supported Currencies
Update ATM Supported Currencies.
Authentication is Mandatory
URL Parameters:
JSON response body fields:
-
atm_id: atme0352a-9a0f-4bfa-b30b-9003aa467f51
-
supported_currencies: ["EUR","MXN","USD"]
{
"atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
"supported_currencies":["EUR","MXN","USD"]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Update ATM Supported Languages
Update ATM Supported Languages.
Authentication is Mandatory
URL Parameters:
JSON response body fields:
-
atm_id: atme0352a-9a0f-4bfa-b30b-9003aa467f51
-
supported_languages: ["es","fr","de"]
{
"atm_id":"atme0352a-9a0f-4bfa-b30b-9003aa467f51",
"supported_languages":["es","fr","de"]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Check Available Funds
Check Available Funds
Mandatory URL parameters:
- amount=NUMBER
- currency=STRING
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
- [date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 2020-01-27
{
"answer":"yes",
"date":"2022-05-17T08:58:48Z",
"available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7"
}
- 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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-20054: Invalid amount. Please specify a valid value for amount.
- OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
- OBP-50000: Unknown Error.
Create Account (POST)
Create Account at bank specified by BANK_ID.
The User can create an Account for himself - or - the User that has the USER_ID specified in the POST body.
If the POST body USER_ID is specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
If the POST body USER_ID is not specified, the account will be owned by the logged in User.
The 'product_code' field SHOULD be a product_code from Product.
If the product_code matches a product_code from Product, account attributes will be created that match the Product Attributes.
Note: The Amount MUST be zero.
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON request body fields:
-
amount: 10.12
-
balance: 10
-
branch_id: DERBY6
-
currency: EUR
-
label: My Account
-
product_code: 1234
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields:
-
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
amount: 10.12
-
balance: 10
-
branch_id: DERBY6
-
currency: EUR
-
label: My Account
-
name: ACCOUNT_MANAGEMENT_FEE
-
product_code: 1234
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
-
value: 5987953
{
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"label":"My Account",
"product_code":"1234",
"balance":{
"currency":"EUR",
"amount":"0"
},
"branch_id":"DERBY6",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"account_attributes":[{
"product_code":"1234",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}]
}
-
CanCreateAccount
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-10001: Incorrect json format.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-30106: Invalid Balance Amount.
- OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00
- OBP-30109: Initial Balance of Account must be Zero (0).
- OBP-30105: Invalid Balance Currency.
- OBP-50000: Unknown Error.
Create Account Attribute
Create Account Attribute
Account Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Account Attribute is linked to its Account by ACCOUNT_ID
Typical account attributes might be:
ISIN (for International bonds)
VKN (for German bonds)
REDCODE (markit short code for credit derivative)
LOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
MATURITY_DATE (End of life time of a product)
TRADABLE
See FPML for more examples.
The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
PRODUCT_CODE: 1234
JSON request body fields:
JSON response body fields:
-
name: ACCOUNT_MANAGEMENT_FEE
-
product_code: 1234
-
value: 5987953
{
"product_code":"1234",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}
-
CanCreateAccountAttributeAtOneBank
- 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-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Create or Update Account Attribute Definition
Create or Update Account Attribute Definition
The category field must be Account
The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
bank_id: gh.29.uk
-
can_be_seen_on_views: true
-
description: This an optional field. Maximum length is 2000. It can be any characters here.
-
is_active: true
-
name: ACCOUNT_MANAGEMENT_FEE
{
"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"bank_id":"gh.29.uk",
"name":"SPECIAL_TAX_NUMBER",
"category":"Account",
"type":"STRING",
"description":"description",
"alias":"STRING",
"can_be_seen_on_views":["bank"],
"is_active":true
}
-
CanCreateAccountAttributeDefinitionAtOneBank
- 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-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Delete Account Attribute Definition
Delete Account Attribute Definition by ATTRIBUTE_DEFINITION_ID
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
CanDeleteAccountAttributeDefinitionAtOneBank
- 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-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Delete Account Cascade
Delete an Account Cascade specified by ACCOUNT_ID.
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
JSON response body fields:
-
CanDeleteAccountCascade
- 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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Account Attribute Definition
Get Account Attribute Definition
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
bank_id: gh.29.uk
-
can_be_seen_on_views: true
-
description: This an optional field. Maximum length is 2000. It can be any characters here.
-
is_active: true
-
name: ACCOUNT_MANAGEMENT_FEE
{
"attributes":[{
"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"bank_id":"gh.29.uk",
"name":"SPECIAL_TAX_NUMBER",
"category":"Account",
"type":"STRING",
"description":"description",
"alias":"STRING",
"can_be_seen_on_views":["bank"],
"is_active":true
}]
}
-
CanGetAccountAttributeDefinitionAtOneBank
- 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-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Account Balances
Get the Balances for one Account of the current User at one bank.
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
JSON response body fields:
{
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"bank_id":"gh.29.uk",
"account_routings":[{
"scheme":"accountNumber",
"address":"123456"
}],
"label":"My Account",
"balances":[{
"type":"",
"currency":"EUR",
"amount":"10"
}]
}
- 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-30065: Cannot find account access.
- OBP-50000: Unknown Error.
Get Account by Account Routing
This endpoint returns the account (if it exists) linked with the provided scheme and address.
The bank_id
field is optional, but if it's not provided, we don't guarantee that the returned account is unique across all the banks.
Example of account routing scheme: IBAN
, "OBP", "AccountNumber", ...
Example of account routing address: DE17500105178275645584
, "321774cc-fccd-11ea-adc1-0242ac120002", "55897106215", ...
Authentication is Mandatory
JSON request body fields:
- bank_id: gh.29.uk
JSON response body fields:
-
amount: 10.12
-
balance: 10
-
bank_id: gh.29.uk
-
can_add_image_url: true
-
can_add_more_info: true
-
can_add_tag: true
-
can_delete_image: true
-
can_delete_where_tag: true
-
can_edit_owner_comment: true
-
can_see_image_url: true
-
can_see_images: true
-
can_see_url: true
-
can_see_where_tag: true
-
currency: EUR
-
[date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 2020-01-27
-
description: This an optional field. Maximum length is 2000. It can be any characters here.
-
is_public: true
-
label: My Account
-
name: ACCOUNT_MANAGEMENT_FEE
-
product_code: 1234
-
provider: ETHEREUM
-
tags: Create-My-User
-
value: 5987953
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"NoneLabel",
"number":"123",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}],
"product_code":"1234",
"balance":{
"currency":"EUR",
"amount":"0"
},
"views_available":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}],
"bank_id":"gh.29.uk",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"account_attributes":[{
"product_code":"1234",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}],
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}]
}
- 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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
- OBP-50000: Unknown Error.
Get Account by Id (Core)
Information returned about the account specified by ACCOUNT_ID:
- Number - The human readable account number given by the bank that identifies the account.
- Label - A label given by the owner of the account
- Owners - Users that own this account
- Type - The type of account
- Balance - Currency and Value
- Account Routings - A list that might include IBAN or national account identifiers
- Account Rules - A list that might include Overdraft and other bank specific rules
- Tags - A list of Tags assigned to this account
This call returns the owner view and requires access to that view.
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
JSON response body fields:
{
"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"bank_id":"gh.29.uk",
"label":"My Account",
"number":"546387432",
"product_code":"AC",
"balance":{
"currency":"EUR",
"amount":"0"
},
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"views_basic":["owner"]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
Get Account by Id (Full)
Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):
- Number
- Owners
- Type
- Balance
- IBAN
- Available views (sorted by short_name)
More details about the data moderation by the view here.
PSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
This call provides balance and other account information via delegated authentication using OAuth.
Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to true
.
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
-
amount: 10.12
-
balance: 10
-
bank_id: gh.29.uk
-
can_add_image_url: true
-
can_add_more_info: true
-
can_add_tag: true
-
can_delete_image: true
-
can_delete_where_tag: true
-
can_edit_owner_comment: true
-
can_see_image_url: true
-
can_see_images: true
-
can_see_url: true
-
can_see_where_tag: true
-
currency: EUR
-
[date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 2020-01-27
-
description: This an optional field. Maximum length is 2000. It can be any characters here.
-
is_public: true
-
label: My Account
-
name: ACCOUNT_MANAGEMENT_FEE
-
product_code: 1234
-
provider: ETHEREUM
-
tags: Create-My-User
-
value: 5987953
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"label":"NoneLabel",
"number":"123",
"owners":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}],
"product_code":"1234",
"balance":{
"currency":"EUR",
"amount":"0"
},
"views_available":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}],
"bank_id":"gh.29.uk",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"account_attributes":[{
"product_code":"1234",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}],
"tags":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"value":"OBP",
"date":"2017-09-19T00:00:00Z",
"user":{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"provider":"http://127.0.0.1:8080",
"display_name":"OBP"
}
}]
}