| banking_interface |
\OpenAPI\Client\Model\BankingInterface |
|
|
| tpp_authentication_group |
\OpenAPI\Client\Model\BankInterfaceTppAuthenticationGroup |
|
[optional] |
| login_credentials |
\OpenAPI\Client\Model\BankInterfaceLoginField[] |
Login fields for this interface (in the order that we suggest to show them to the user)<br/> <strong>Type:</strong> BankInterfaceLoginField |
|
| properties |
BankInterfaceProperty[] |
Set of interface properties/specifics. Possible values:<br><br>• <code>REDIRECT_APPROACH</code> - means that the interface uses a redirect approach when authorizing the user. It requires you to pass the 'redirectUrl' field in all services which define the field. If the user already has imported a bank connection of the same bank that he is about to import, we recommend to confront the user with the question: <blockquote>For the selected bank you have already imported successfully the following accounts: <account list>. Are you sure that you want to import another bank connection from <bank name>? </blockquote>• <code>DECOUPLED_APPROACH</code> - means that the interface can trigger a decoupled approval during user authorization.<br/><br/>• <code>DETAILED_CONSENT</code> - means that the interface requires a list of account references when authorizing the user. It requires you to pass the 'accountReferences' field in all services which define the field.<br/><br/>Note that this set will be empty if the interface does not have any specific properties.<br/> <strong>Type:</strong> BankInterfaceProperty |
|
| login_hint |
string |
Login hint. Contains a German message for the user that explains what kind of credentials are expected.<br/><br/>Please note that it is essential to always show the login hint to the user if there is one, as the credentials that finAPI requires for the bank might be different to the credentials that the user knows from his online banking.<br/><br/>Also note that the contents of this field should always be interpreted as HTML, as the text might contain HTML tags for highlighted words, paragraphs, etc. |
[optional] |
| health |
int |
The health status of this interface. This is a value between 0 and 100, depicting the percentage of successful communication attempts with the bank via this interface during the last couple of bank connection imports or updates (across the entire finAPI system). <br/><br/>Note:<br/>• 'Successful' communication attempt means that there was no technical error trying to establish a communication with the bank. Non-technical errors (like incorrect credentials) are regarded successful communication attempts.<br/>• If an interface is not supported (see fields 'isAisSupported'/'isPisSupported'), the health will always be 0. |
|
| last_communication_attempt |
\DateTime |
<strong>Format:</strong> 'YYYY-MM-DD'T'HH:MM:SS.SSSXXX' (RFC 3339, section 5.6)<br/>Time of the last communication attempt with this interface during an import, update or connect interface (across the entire finAPI system). |
[optional] |
| last_successful_communication |
\DateTime |
<strong>Format:</strong> 'YYYY-MM-DD'T'HH:MM:SS.SSSXXX' (RFC 3339, section 5.6)<br/>Time of the last successful communication with this interface during an import, update or connect interface (across the entire finAPI system). |
[optional] |
| is_ais_supported |
bool |
Whether this interface has the general capability to perform Account Information Services (AIS), i.e. if this interface can be used to download accounts, balances and transactions. |
|
| is_pis_supported |
bool |
Whether this interface has the general capability to perform Payment Initiation Services (PIS). For more details, see the field 'paymentCapabilities'. |
|
| payment_capabilities |
\OpenAPI\Client\Model\BankInterfacePaymentCapabilities |
|
|
| payment_constraints |
\OpenAPI\Client\Model\BankInterfacePaymentConstraints |
|
[optional] |
| ais_account_types |
AccountType[] |
The set of account types that we can confirm can be successfully imported through this interface. This field can help you select the appropriate interface if you want to fetch only specific account types when importing or updating a bank connection (see the field <code>accountTypes</code> in the respective services).<br/><br/>Note:<br/>• The set can change over time. When we learn that a certain account type can be received, it will be added to the set. But an account type can also disappear from the set, when it was no longer received for a while.<br/>• If an account type is not contained in the set, it could still be that the interface will provide such accounts - we just haven't seen this for a while. Accordingly, this field is only meant to hint you at the most promising interface. If none of a bank's interfaces have your desired account type listed, we still advise you to make an attempt.<br/>• The set is not updated in real-time, but rather periodically. When you make a successful import of an account type that is not yet listed, there will be a delay until it appears.<br/> <strong>Type:</strong> AccountType |
|