BanksAPI

Creates a technical user corresponding (one-to-one) a tenant's user. Users are needed to use BANKSapi's core features like adding accounts or performing payments. After creating a user, they're automatically activated. Mocked via Mockzilla.

Get all activated users

Creates a client or user token valid for 24 hours. Client tokens are needed for administrative use cases such as creating users. User tokens are needed when creating or querying banking accounts.

Get all tenants

This function can be used to retrieve a single activated user.

Deletes a single user. The user must be deactivated beforehand. Available as a Mockzilla mock endpoint.

Changes user details, such as username, first name or last name

Deactivates a single user

Reactivate a single deactivated user

To revoke a token, the user token is sent to the URL https://banksapi.io/auth/oauth2/revoke via a POST request.

Returns information about a token. Mockzilla mock: no signup, no API key.

Encrypt a given plaintext for the tenant identified by the given bearer token.

Retrieve a list of and information for all providers.

Retrieve a list of core data for all providers.

Retrieve a list of provider logos with statistical data about the data jobs. If there were no successful data jobs or no data jobs at all in the specified time period, no entry is returned for the corresponding logo.

Retrieve information for a specific provider. Served by the Mockzilla mock runtime.

Retrieve EBICS information for a specific provider (if available).

Retrieves the customer object for the authenticated user. It is also the entry point to the deeper functions of the interface.

Adds a bank access for the given user and set of credentials.

Retrieves all bank accesses for this user.

Removes all bank accesses of the authenticated user. Mocked via Mockzilla.

Retrieves a specific bank access for this user.

Deletes a specific bank access.

Retrieves last known issues for a specific bank access for this user.

Retrieves the PDF file from the bank access challenge if available.

Retrieve information for a single bank product. Available as a Mockzilla mock endpoint.

Retrieves all transactions for a specific product of a specific access of this user.

Pushes transactions for the given product identified by an access and a product ID

This method applies corrections to the categorization of transactions. Initial categorization is required before recategorization. Input contains the tag tree item that should be used for recategorization. A valid tag tree item has to be provided. The flag createRule creates a user specific rule that automatically categorizes this counterparty with the provided tag tree item in all future transactions. This is a smart solution to eradicate a recurring recategorization process. The flag changeExisting recategorizes all existing transactions of the same counterparty. The tagTreeItem has to include a tagTree and has to be wrapped in tags: []. The recategorization currently relies on the systemName value of tagTreeItem and tagTree, but as this might change in the future, both systemName and systemId should be included in the payload, all other fields are ignored. To get a full list of tag tree items, use: GET https://banksapi.io/tags/v1/tags/tag_trees/1/tag_tree_items/

Retrieves all investments in a specific banking product of type brokerage account (portfolio depot) for this user.

Starts the SCA renewal process. Mockzilla mock: no signup, no API key.

Submits a SCA method, medium or authentication data for the current SCA (e.g. when creating a bank access).

Can be used for the decoupled SCA approach to check if the SCA has already been confirmed.

Cancels an SCA redirect and stops the corresponding access synchronization. This request is permitted only for the redirect SCA approach.

Initiates a payment for the given bank access, without providing access credentials

Initiates a payment for the given bank access, without providing access credentials. Served by the Mockzilla mock runtime.

Initiates a payment for the given bank access, without providing access credentials

Initiates a payment for the given bank access, without providing access credentials

Creates a payment (i.e. initializes a SEPA transfer).

Creates a bulk payment (i.e. initializes a SEPA transfer).

Submits a TAN for a previously created payment. Mocked via Mockzilla.

Submits a TAN for a previously created bulk payment. Confer Submit TAN for details.

Initiates a single transfer (e.g. a SEPA transfer).

Get the current status of the single transfer.

Initiates a bulk transfer (e.g. a SEPA bulk transfer).

Get the current status of the bulk transfer. Available as a Mockzilla mock endpoint.

Initiates a single debit (e.g. a SEPA debit).

Get the current status of the single debit.

Initiates a bulk debit (e.g. a SEPA debit).

Get the current status of the bulk debit.

Get the current status of the consent, without polling the provider. Mockzilla mock: no signup, no API key.

Submits a SCA method, medium or authentication data for the current SCA.

Can be used for the decoupled SCA approach to check if the SCA has already been confirmed.

Cancels an SCA redirect and stops the corresponding access synchronization. This request is permitted only for the redirect SCA approach.

Invalidates all REG/Protect sessions of the authenticated user.

Change the selected products of the given bank access. Served by the Mockzilla mock runtime.

Creates a builder instance for a bank access.