Download the PHP package adaptech/finapi-access without Composer

Table of contents
Download adaptech/finapi-access
More information about adaptech/finapi-access
Files in adaptech/finapi-access

Vendor adaptech
Package finapi-access
Short Description RESTful API for Account Information Services (AIS) and Payment Initiation Services (PIS) The following pages give you some general information on how to use our APIs.
The actual API services documentation then follows further below. You can use the menu to jump between API sections.

This page has a built-in HTTP(S) client, so you can test the services directly from within this page, by filling in the request parameters and/or body in the respective services, and then hitting the TRY button. Note that you need to be authorized to make a successful API call. To authorize, refer to the 'Authorization' section of the API, or just use the OAUTH button that can be found near the TRY button.

General information

Error Responses

When an API call returns with an error, then in general it has the structure shown in the following example:

 {   "errors": [     {       "message": "Interface 'FINTS_SERVER' is not supported for this operation.",       "code": "BAD_REQUEST",       "type": "TECHNICAL"     }   ],   "date": "2020-11-19 16:54:06.854",   "requestId": "selfgen-312042e7-df55-47e4-bffd-956a68ef37b5",   "endpoint": "POST /api/v1/bankConnections/import",   "authContext": "1/21",   "bank": "DEMO0002 - finAPI Test Redirect Bank" } 

If an API call requires an additional authentication by the user, HTTP code 510 is returned and the error response contains the additional "multiStepAuthentication" object, see the following example:

 {   "errors": [     {       "message": "Es ist eine zusätzliche Authentifizierung erforderlich. Bitte geben Sie folgenden Code an: 123456",       "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",       "type": "BUSINESS",       "multiStepAuthentication": {         "hash": "678b13f4be9ed7d981a840af8131223a",         "status": "CHALLENGE_RESPONSE_REQUIRED",         "challengeMessage": "Es ist eine zusätzliche Authentifizierung erforderlich. Bitte geben Sie folgenden Code an: 123456",         "answerFieldLabel": "TAN",         "redirectUrl": null,         "redirectContext": null,         "redirectContextField": null,         "twoStepProcedures": null,         "photoTanMimeType": null,         "photoTanData": null,         "opticalData": null       }     }   ],   "date": "2019-11-29 09:51:55.931",   "requestId": "selfgen-45059c99-1b14-4df7-9bd3-9d5f126df294",   "endpoint": "POST /api/v1/bankConnections/import",   "authContext": "1/18",   "bank": "DEMO0001 - finAPI Test Bank" } 

An exception to this error format are API authentication errors, where the following structure is returned:

 {   "error": "invalid_token",   "error_description": "Invalid access token: cccbce46-xxxx-xxxx-xxxx-xxxxxxxxxx" } 

Paging

API services that may potentially return a lot of data implement paging. They return a limited number of entries within a "page". Further entries must be fetched with subsequent calls.

Any API service that implements paging provides the following input parameters:
• "page": the number of the page to be retrieved (starting with 1).
• "perPage": the number of entries within a page. The default and maximum value is stated in the documentation of the respective services. A paged response contains an additional "paging" object with the following structure:

 {   ...   ,   "paging": {     "page": 1,     "perPage": 20,     "pageCount": 234,     "totalCount": 4662   } } 

Internationalization

The finAPI services support internationalization which means you can define the language you prefer for API service responses.

The following languages are available: German, English, Czech, Slovak.

The preferred language can be defined by providing the official HTTP Accept-Language header.

finAPI reacts on the official iso language codes "de", "en", "cs" and "sk" for the named languages. Additional subtags supported by the Accept-Language header may be provided, e.g. "en-US", but are ignored.
If no Accept-Language header is given, German is used as the default language.

Exceptions:
• Bank login hints and login fields are only available in the language of the bank and not being translated.
• Direct messages from the bank systems typically returned as BUSINESS errors will not be translated.
• BUSINESS errors created by finAPI directly are available in German and English.
• TECHNICAL errors messages meant for developers are mostly in English, but also may be translated.

Request IDs

With any API call, you can pass a request ID via a header with name "X-Request-Id". The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error.

If you don't pass a request ID for a call, finAPI will generate a random ID internally.

The request ID is always returned back in the response of a service, as a header with name "X-Request-Id".

We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.

Overriding HTTP methods

Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with a special HTTP header indicating the originally intended HTTP method.

The header's name is X-HTTP-Method-Override. Set its value to either PATCH or DELETE. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers.

Example:

X-HTTP-Method-Override: PATCH
POST /api/v1/label/51
{"name": "changed label"}

will be interpreted by finAPI as:

PATCH /api/v1/label/51
{"name": "changed label"}

User metadata

With the migration to PSD2 APIs, a new term called "User metadata" (also known as "PSU metadata") has been introduced to the API. This user metadata aims to inform the banking API if there was a real end-user behind an HTTP request or if the request was triggered by a system (e.g. by an automatic batch update). In the latter case, the bank may apply some restrictions such as limiting the number of HTTP requests for a single consent. Also, some operations may be forbidden entirely by the banking API. For example, some banks do not allow issuing a new consent without the end-user being involved. Therefore, it is certainly necessary and obligatory for the customer to provide the PSU metadata for such operations.

As finAPI does not have direct interaction with the end-user, it is the client application's responsibility to provide all the necessary information about the end-user. This must be done by sending additional headers with every request triggered on behalf of the end-user.

At the moment, the following headers are supported by the API:
• "PSU-IP-Address" - the IP address of the user's device.
• "PSU-Device-OS" - the user's device and/or operating system identification.
• "PSU-User-Agent" - the user's web browser or other client device identification.

FAQ

Is there a finAPI SDK?
Currently we do not offer a native SDK, but there is the option to generate a SDK for almost any target language via OpenAPI. Use the 'Download SDK' button on this page for SDK generation.

How can I enable finAPI's automatic batch update?
Currently there is no way to set up the batch update via the API. Please contact [email protected] for this.

Why do I need to keep authorizing when calling services on this page?
This page is a "one-page-app". Reloading the page resets the OAuth authorization context. There is generally no need to reload the page, so just don't do it and your authorization will persist.
License unlicense
Homepage https://openapi-generator.tech