Featured API Endpoints
This page shows featured APIs collections and frequently used endpoints.
BGv1.3-getAccountList
BGv1.3-initiatePayments
BGv1.3-updatePaymentPsuDataTransactionAuthorisation
OBPv1.4.0-
OBPv4.0.0-getMyPersonalUserAttributes
Get Entitlements for the current User
.
/obp/v6.0.0/my/entitlementsGet User (Current)
Get the logged in user
/obp/v6.0.0/users/currentGet My Api Collections
Get all the apiCollections for logged in user.
/obp/v6.0.0/my/api-collectionsGet Glossary of the API
Get API Glossary
Returns the glossary of the API
/obp/v6.0.0/api/glossaryGet My Api Collection Endpoints
Get Api Collection Endpoints By API_COLLECTION_NAME.
/obp/v6.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpointsGet Well Known URIs
Get the OAuth2 server's public Well Known URIs.
/obp/v6.0.0/well-knownCreate Dynamic Resource Doc
Create a Dynamic Resource Doc.
The connector_method_body is URL-encoded format String
/obp/v6.0.0/management/dynamic-resource-docsGet Correlated Entities for the current User
Correlated Entities are users and customers linked to the currently authenticated user via User-Customer-Links
/obp/v6.0.0/my/correlated-entitiesGet API Info (root)
Returns information about:
API version Hosted by information Hosted at information Energy source information * Git Commit
/obp/v6.0.0/rootGet 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
/obp/v6.0.0/banksGet 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
/obp/v6.0.0/banksGet Public Accounts at all Banks
Get public accounts at all banks (Anonymous access). Returns accounts that contain at least one public view (a view where is_public is true) For each account the API returns the ID and the available views.
/obp/v6.0.0/accounts/publicGet 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.
/obp/v6.0.0/oidc/clients/CLIENT_IDCreate sandbox
Import bulk data into the sandbox (Authenticated access).
This call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.
The user needs to have CanCreateSandbox entitlement.
Note: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.
/obp/v6.0.0/sandbox/data-importShowing 19 featured endpoints