Featured API Endpoints

This page shows featured APIs collections and frequently used endpoints.

BGv1.3-updatePaymentPsuDataTransactionAuthorisation

OBPv1.2.1-privateAccountsAllBanks

Get My Personal User Attributes

.

GET /obp/v6.0.0/my/user/attributes

Get all Authentication Type Validations - public

.

GET /obp/v6.0.0/endpoints/authentication-type-validations

Get all JSON Schema Validations - public

.

GET /obp/v6.0.0/endpoints/json-schema-validations

Get User (Current)

Get the logged in user

GET /obp/v6.0.0/users/current

Get Correlated Entities for the current User

Correlated Entities are users and customers linked to the currently authenticated user via User-Customer-Links

GET /obp/v6.0.0/my/correlated-entities

Get API Info (root)

Returns information about:

API version Hosted by information Hosted at information Energy source information * Git Commit

GET /obp/v6.0.0/root

Get Banks

Get banks on this API instance Returns a list of banks supported on this server:

- bank_id used as parameter in URLs - Short and full name of bank - Logo URL - Website

GET /obp/v6.0.0/banks
BankAccount Information Service (AIS)PSD2

Get Banks

Get banks on this API instance Returns a list of banks supported on this server:

- bank_id used as parameter in URLs - Short and full name of bank - Logo URL - Website

GET /obp/v6.0.0/banks
BankAccount Information Service (AIS)PSD2

Get OIDC Client

Gets an OIDC/OAuth2 client's metadata by client_id.

Returns client information including name, consumer_id, redirect_uris, and enabled status. This endpoint does not verify the client secret - use POST /oidc/clients/verify for authentication.

GET /obp/v6.0.0/oidc/clients/CLIENT_ID

Get Message Docs

These message docs provide example messages sent by OBP to the (RabbitMq) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes. Integrators can use these messages to build Adapters that provide core banking services to OBP.

Note: API Explorer provides a Message Docs page where these messages are displayed. CONNECTOR: rest_vMar2019, stored_procedure_vDec2019 ...

GET /obp/v6.0.0/message-docs/CONNECTOR
Message-DocDocumentationAPI

Showing 19 featured endpoints