Featured API Endpoints

.

.

Update ATM.

for the Bank.

Get all the apiCollections for logged in user.

Get the OAuth2 server's public Well Known URIs.

Returns information about:

* Suggested session timeout in case of a user inactivity

Returns information about:

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

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

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 the list of authentication providers that have been used to create users on this OBP instance.

This endpoint returns a distinct list of provider values from the resource_user table.

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 ...

This endpoint is used to begin the process of creating a consent that may be used for Variable Recurring Payments (VRPs).

VRPs are useful in situations when a beneficiary needs to be paid different amounts on a regular basis.

Once granted, the consent allows its holder to initiate multiple Transaction Requests to the Counterparty defined in this endpoint as long as the Counterparty Limits linked to this particular consent are respected.

Client, Consumer or Application Authentication is mandatory for this endpoint.

i.e. the caller of this endpoint is the API Client, Consumer or Application rather than a specific User.

At the end of the process the following objects are created in OBP or connected backend systems: - An automatically generated View which controls access. - A Counterparty that is the Beneficiary of the Variable Recurring Payments. The Counterparty specifies the Bank Account number or other routing address. - Limits for the Counterparty which constrain the amount of money that can be sent to it in various periods (yearly, monthly, weekly).

The Account holder may modify the Counterparty or Limits e.g. to increase or decrease the maximum possible payment amounts or the frequencey of the payments.

In the case of a public client we use the client_id and private key to obtain an access token, otherwise we use the client_id and client_secret. The obtained access token is used in the HTTP Authorization header of the request as follows:

Example: Authorization: Bearer eXtneO-THbQtn3zvK_kQtXXfvOZyZFdBCItlPDbR2Bk.dOWqtXCtFX-tqGTVR0YrIjvAolPIVg7GZ-jz83y6nA0

After successfully creating the VRP consent request, you need to call the Create Consent By CONSENT_REQUEST_ID endpoint to finalize the consent using the CONSENT_REQUEST_ID returned by this endpoint.

Application Access is Required. The Application must be authenticated.

Get all scanned API versions available in this codebase.

This endpoint returns all API versions that have been discovered/scanned, along with their active status.

Response Fields:

url_prefix: The URL prefix for the version (e.g., "obp", "berlin-group", "open-banking") api_standard: The API standard name (e.g., "OBP", "BG", "UK", "STET") api_short_version: The version number (e.g., "v4.0.0", "v1.3") fully_qualified_version: The fully qualified version combining standard and version (e.g., "OBPv4.0.0", "BGv1.3") is_active: Boolean indicating if the version is currently enabled and accessible

Active Status:

is_active=true: Version is enabled and can be accessed via its URL prefix is_active=false: Version is scanned but disabled (via api_disabled_versions props)

Use Cases:

Discover what API versions are available in the codebase Check which versions are currently enabled Verify that disabled versions configuration is working correctly * API documentation and discovery

Note: This differs from v4.0.0's /api/versions endpoint which shows all scanned versions without is_active status.