API Explorer

⯆

API Explorer

My Collections

API
- The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeably
  More...
- 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
- Waiting For Godot
ATM
Account
- The thing that tokens of value (money) come in and out of. An account has one or more `owners` which
  More...
- Check Available Funds
- Create Account
- 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 can
  More...
- Create (DAuth) User with Account Access
- Grant User access to View
- Revoke User access to View
- Revoke/Grant User access to View
Account Application
Account Metadata
Account Public
Api Collection
Authentication Type Validation
Bank
- A Bank (aka Space) represents a financial institution, brand or organizational unit under which res
  More...
- Create Bank
- Create Bank Attribute
- Create Settlement Account
- Create Transaction Type at bank
- 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
- Update Bank Attribute
Branch
Card
Connector Method
- Developers can override all the existing Connector methods. This function needs to be used togeth
  More...
- Create Connector Method
- Get Connector Method by Id
- Get all Connector Methods
- Update Connector Method
Consent
- Consents provide a mechanism by which a third party App or User can access resources on behalf of a
  More...
- Add User to a Consent
- Answer Consent Challenge
- Create Consent (EMAIL)
- Create Consent (SMS)
- Create Consent By CONSENT_REQUEST_ID (EMAIL)
- Create Consent By CONSENT_REQUEST_ID (SMS)
- Create Consent Request
- Get Consent By Consent Request Id
- Get Consent Request
- Get Consents
- Get Consents Info
- Provide client's certificate info of a current call
- Revoke Consent
- Revoke Consent at Bank
- Revoke Consent used in the Current Call
- Update Consent Status
Consumer
- The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on be
  More...
- 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
Counterparty Metadata
Customer
Customer Meeting
Customer Message
Data Warehouse
Direct Debit
Documentation
Dynamic Endpoint Manage
- If you want to create endpoints from Swagger / Open API specification files, use Dynamic Endpoints
  More...
- 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 and
  More...
- Create Bank Level Dynamic Entity
- Create System Level Dynamic Entity
- Delete Bank Level Dynamic Entity
- Delete My Dynamic Entity
- Delete System Level Dynamic Entity
- Get Bank Level Dynamic Entities
- Get My Dynamic Entities
- Get System Dynamic Entities
- Update Bank Level Dynamic Entity
- Update My Dynamic Entity
- Update System Level Dynamic Entity
Dynamic Message Doc
- In OBP we represent messages sent by a Connector method / function as MessageDocs. A MessageDoc d
  More...
- 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
Endpoint Mapping
- Endpoint Mapping can be used to map each JSON field in a Dynamic Endpoint to different Dynamic Enti
  More...
- 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
FX
JSON Schema Validation
- JSON Schema is "a vocabulary that allows you to annotate and validate JSON documents". By applying
  More...
- 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
KYC
Method Routing
- Open Bank Project can have different connectors, to connect difference data sources. We support
  More...
- Create MethodRouting
- Delete MethodRouting
- Get MethodRoutings
- Update MethodRouting
Metric
Product
Product Collection
Role
Sandbox
- Create sandbox
Scope
Standing Order
System Integrity
Transaction
- Transactions are records of successful movements of value into or out of an `Account`. OBP Transac
  More...
- Create Transaction Attribute
- Create or Update Transaction Attribute Definition
- Delete Transaction Attribute Definition
- Delete Transaction Cascade
- Get Balancing Transaction
- 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
User
- The entity that accesses the API with a login / authorisation token and has access to zero or more
  More...
- Answer User Auth Context Update Challenge
- Create My Personal User Attribute
- Create Non Personal User Attribute
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Create password reset url
- Delete Non Personal User Attribute
- Delete User Auth Context
- Delete User's Auth Contexts
- Delete a User
- Get Logout Link
- Get My Personal User Attributes
- Get My Spaces
- Get Non Personal User Attributes
- Get User (Current)
- Get User Auth Contexts
- Get User Id (Current)
- Get User Lock Status
- Get User by USERNAME
- Get User by USER_ID
- Get User with Attributes by USER_ID
- Get Users by Email Address
- Get all Users
- Lock the user
- Refresh User
- Unlock the user
- Update My Personal User Attribute
User Invitation
View Custom
View System
WebUi Props
Webhook

Log off

v5.1.0 (505 APIs)

API Host: https://api3.openbankproject.com

Create Customer Message

Create a message for the customer specified by CUSTOMER_ID
Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON request body fields:

from_department: Open Bank

from_person: Tom

message: 123456

transport: SMS

JSON response body fields:

success:

Typical Successful Response:

								
									{
  "success":"Success"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateCustomerMessage - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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:

Connector Methods:

Version: OBPv4.0.0, function_name: by createCustomerMessage, operation_id: OBPv4.0.0-createCustomerMessage Tags: Customer-Message, Customer, Person,

Create Customer Message

Create a message for the customer specified by CUSTOMER_ID

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON request body fields:

from_department: Open Bank

from_person: Tom

message: 123456

JSON response body fields:

success:

Typical Successful Response:

								
									{
  "success":"Success"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv1.4.0, function_name: by addCustomerMessage, operation_id: OBPv1.4.0-addCustomerMessage Tags: Customer-Message, Customer, Person,

Get Customer Messages for a Customer

Get messages for the customer specified by CUSTOMER_ID
Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

date: 2020-01-27

from_department: Open Bank

from_person: Tom

id: d8839721-ad8f-45dd-9f78-2080414b93f9

message: 123456

messages:

transport: SMS

Typical Successful Response:

								
									{
  "messages":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "date":"1100-01-01T00:00:00Z",
    "transport":"SMS",
    "message":"123456",
    "from_department":"Open Bank",
    "from_person":"Tom"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetCustomerMessages - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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:

Connector Methods:

Version: OBPv4.0.0, function_name: by getCustomerMessages, operation_id: OBPv4.0.0-getCustomerMessages Tags: Customer-Message, Customer,

Get Customer Messages for all Customers

Get messages for the logged in customer
Messages sent to the currently authenticated user.

Authentication via OAuth is required.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

date: 2020-01-27

from_department: Open Bank

from_person: Tom

id: d8839721-ad8f-45dd-9f78-2080414b93f9

message: 123456

messages:

Typical Successful Response:

								
									{
  "messages":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "date":"1100-01-01T00:00:00Z",
    "message":"String",
    "from_department":"String",
    "from_person":"String"
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Connector Methods:

obp.getBankLegacy

Version: OBPv1.4.0, function_name: by getCustomersMessages, operation_id: OBPv1.4.0-getCustomersMessages Tags: Customer-Message, Customer,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

v5.1.0 (505 APIs)

Create Customer Message

Create Customer Message

Get Customer Messages for a Customer

Get Customer Messages for all Customers