All URIs are relative to https://localhost
| Method | HTTP request | Description |
|---|---|---|
| delete_account | DELETE /api/v1/accounts/{id} | Delete an account |
| delete_all_accounts | DELETE /api/v1/accounts | Delete all accounts |
| edit_account | PATCH /api/v1/accounts/{id} | Edit an account |
| execute_sepa_direct_debit | POST /api/v1/accounts/executeSepaDirectDebit | Execute SEPA Direct Debit |
| execute_sepa_money_transfer | POST /api/v1/accounts/executeSepaMoneyTransfer | Execute SEPA Money Transfer |
| get_account | GET /api/v1/accounts/{id} | Get an account |
| get_and_search_all_accounts | GET /api/v1/accounts | Get and search all accounts |
| get_daily_balances | GET /api/v1/accounts/dailyBalances | Get daily balances |
| get_multiple_accounts | GET /api/v1/accounts/{ids} | Get multiple accounts |
| request_sepa_direct_debit | POST /api/v1/accounts/requestSepaDirectDebit | Request SEPA Direct Debit |
| request_sepa_money_transfer | POST /api/v1/accounts/requestSepaMoneyTransfer | Request SEPA Money Transfer |
delete_account(id)
Delete an account
Delete a single bank account of the user that is authorized by the access_token, including its transactions and balance data. Must pass the account's identifier and the user's access_token.
Notes:
- You cannot delete an account while the bank connection that it relates to is currently in the process of import, update, or transactions categorization.
- When the last remaining account of a bank connection gets deleted, then the bank connection itself will get deleted as well!
- All notification rules that are connected to the account will get adjusted so that they no longer have this account listed. Notification rules that are connected to just this account (and no other accounts) will get deleted altogether.
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: finapi_auth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
id = 789 # int | Identifier of the account to delete
try:
# Delete an account
api_instance.delete_account(id)
except ApiException as e:
print("Exception when calling AccountsApi->delete_account: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | Identifier of the account to delete |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IdentifierList delete_all_accounts()
Delete all accounts
Delete all accounts of the user that is authorized by the access_token, including all transactions and balance data. Must pass the user's access_token.
Notes:
- Deleting all of the user's accounts also deletes all of his bank connections.
- All notification rules that are connected to any specific accounts will get deleted as well.
- If at least one of the user's bank connections in currently in the process of import, update, or transactions categorization, then this service will perform no action at all.
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: finapi_auth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
try:
# Delete all accounts
api_response = api_instance.delete_all_accounts()
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->delete_all_accounts: %s\n" % e)This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Account edit_account(id, body=body)
Edit an account
Change the name and/or the type and/or the 'isNew' flag of a single bank account of the user that is authorized by the access_token. Must pass the account's identifier, the account's new name and/or type and/or 'isNew' flag, and the user's access_token.
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: finapi_auth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
id = 789 # int | Identifier of the account to edit
body = swagger_client.AccountParams() # AccountParams | New account name and/or type and/or 'isNew' flag (optional)
try:
# Edit an account
api_response = api_instance.edit_account(id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->edit_account: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | Identifier of the account to edit | |
| body | AccountParams | New account name and/or type and/or 'isNew' flag | [optional] |
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
BankResponse execute_sepa_direct_debit(body)
Execute SEPA Direct Debit
Execute a SEPA direct debit order that has been previously submitted by the use of the /requestSepaDirectDebit service. Note that this service cannot be used for the demo account.
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: finapi_auth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
body = swagger_client.ExecuteSepaDirectDebitParams() # ExecuteSepaDirectDebitParams | Parameters for the execution of a SEPA direct debit order
try:
# Execute SEPA Direct Debit
api_response = api_instance.execute_sepa_direct_debit(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->execute_sepa_direct_debit: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | ExecuteSepaDirectDebitParams | Parameters for the execution of a SEPA direct debit order |
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
BankResponse execute_sepa_money_transfer(body)
Execute SEPA Money Transfer
Execute a SEPA money transfer order that has been previously submitted by the use of the /requestSepaMoneyTransfer service. Note that this service cannot be used for the demo account.
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: finapi_auth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
body = swagger_client.ExecuteSepaMoneyTransferParams() # ExecuteSepaMoneyTransferParams | Parameters for the execution of a SEPA money transfer order
try:
# Execute SEPA Money Transfer
api_response = api_instance.execute_sepa_money_transfer(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->execute_sepa_money_transfer: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | ExecuteSepaMoneyTransferParams | Parameters for the execution of a SEPA money transfer order |
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Account get_account(id)
Get an account
Get a single bank account of the user that is authorized by the access_token. Must pass the account's identifier and the user's access_token.
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: finapi_auth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
id = 789 # int | Identifier of requested account
try:
# Get an account
api_response = api_instance.get_account(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->get_account: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | Identifier of requested account |
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AccountList get_and_search_all_accounts(ids=ids, search=search, account_type_ids=account_type_ids, bank_connection_ids=bank_connection_ids, min_last_successful_update=min_last_successful_update, max_last_successful_update=max_last_successful_update, min_balance=min_balance, max_balance=max_balance)
Get and search all accounts
Get bank accounts of the user that is authorized by the access_token. Must pass the user's access_token. You can set optional search criteria to get only those bank accounts that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service.
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: finapi_auth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
ids = [56] # list[int] | A comma-separated list of account identifiers. If specified, then only accounts whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. (optional)
search = 'search_example' # str | If specified, then only those accounts will be contained in the result whose 'accountName', 'iban', 'accountNumber' or 'subAccountNumber' contains the given search string (the matching works case-insensitive). If no accounts contain the search string in any of these fields, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the searched fields in order for an account to get included into the result. (optional)
account_type_ids = [56] # list[int] | A comma-separated list of account types. If specified, then only accounts that relate to the given types will be regarded. If not specified, then all accounts will be regarded. (optional)
bank_connection_ids = [56] # list[int] | A comma-separated list of bank connection identifiers. If specified, then only accounts that relate to the given bank connections will be regarded. If not specified, then all accounts will be regarded. (optional)
min_last_successful_update = 'min_last_successful_update_example' # str | Lower bound for a account's last successful update date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only accounts whose 'lastSuccessfulUpdate' is equal to or later than the given date will be regarded. (optional)
max_last_successful_update = 'max_last_successful_update_example' # str | Upper bound for a account's last successful update date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only accounts whose 'lastSuccessfulUpdate' is equal to or earlier than the given date will be regarded. (optional)
min_balance = 8.14 # float | If specified, then only accounts whose balance is equal to or greater than the given balance will be regarded. Can contain a positive or negative number with at most two decimal places. Examples: -300.12, or 90.95 (optional)
max_balance = 8.14 # float | If specified, then only accounts whose balance is equal to or less than the given balance will be regarded. Can contain a positive or negative number with at most two decimal places. Examples: -300.12, or 90.95 (optional)
try:
# Get and search all accounts
api_response = api_instance.get_and_search_all_accounts(ids=ids, search=search, account_type_ids=account_type_ids, bank_connection_ids=bank_connection_ids, min_last_successful_update=min_last_successful_update, max_last_successful_update=max_last_successful_update, min_balance=min_balance, max_balance=max_balance)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->get_and_search_all_accounts: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| ids | list[int] | A comma-separated list of account identifiers. If specified, then only accounts whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. | [optional] |
| search | str | If specified, then only those accounts will be contained in the result whose 'accountName', 'iban', 'accountNumber' or 'subAccountNumber' contains the given search string (the matching works case-insensitive). If no accounts contain the search string in any of these fields, then the result will be an empty list. NOTE: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must be contained in the searched fields in order for an account to get included into the result. | [optional] |
| account_type_ids | list[int] | A comma-separated list of account types. If specified, then only accounts that relate to the given types will be regarded. If not specified, then all accounts will be regarded. | [optional] |
| bank_connection_ids | list[int] | A comma-separated list of bank connection identifiers. If specified, then only accounts that relate to the given bank connections will be regarded. If not specified, then all accounts will be regarded. | [optional] |
| min_last_successful_update | str | Lower bound for a account's last successful update date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only accounts whose 'lastSuccessfulUpdate' is equal to or later than the given date will be regarded. | [optional] |
| max_last_successful_update | str | Upper bound for a account's last successful update date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only accounts whose 'lastSuccessfulUpdate' is equal to or earlier than the given date will be regarded. | [optional] |
| min_balance | float | If specified, then only accounts whose balance is equal to or greater than the given balance will be regarded. Can contain a positive or negative number with at most two decimal places. Examples: -300.12, or 90.95 | [optional] |
| max_balance | float | If specified, then only accounts whose balance is equal to or less than the given balance will be regarded. Can contain a positive or negative number with at most two decimal places. Examples: -300.12, or 90.95 | [optional] |
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DailyBalanceList get_daily_balances(account_ids=account_ids, start_date=start_date, end_date=end_date, with_projection=with_projection, page=page, per_page=per_page, order=order)
Get daily balances
Returns the daily balances for the given accounts and the given period. The balances are calculated by finAPI and are based on each account's latest balance.
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: finapi_auth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
account_ids = [56] # list[int] | A comma-separated list of (non-security) account identifiers. If no accounts are specified, all (non-security) accounts of the current user are regarded. (optional)
start_date = 'start_date_example' # str | A string in the format 'YYYY-MM-DD'. Note that the requested date range [startDate..endDate] may not exceed 365 days. If startDate is not specified, it defaults to the endDate minus one month. (optional)
end_date = 'end_date_example' # str | A string in the format 'YYYY-MM-DD'. Note that the requested date range [startDate..endDate] may not exceed 365 days. If endDate is not specified, it defaults to today's date. (optional)
with_projection = true # bool | Whether finAPI should project the first and last actually existing balance into the past and future. When passing 'true', then the result will always contain a daily balance for every day of the entire requested date range, even for days before the first actually existing balance, resp. after the last actually existing balance. Those days will have the same balance as the day of the first actual balance, resp. last actual balance, i.e. the first/last balance will be infinitely projected into the past/the future. When passing 'false', then the result will contain daily balances only from the day on where the first actual balance exists for any of the given accounts, and only up to the day where the last actual balance exists for any of the given accounts. Note that when in this case there are no actual balances within the requested date range, then an empty array will be returned. Default value for this parameter is 'true'. (optional) (default to true)
page = 1 # int | Result page that you want to retrieve. (optional) (default to 1)
per_page = 20 # int | Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. (optional) (default to 20)
order = ['order_example'] # list[str] | Determines the order of the results. You can order the results by 'date', 'balance', 'income' or 'spending'. The default order for this service is 'date,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/accounts/dailyBalances?order=date,desc&order=balance,asc' will return daily balances ordered by 'date' (descending), where items with the same 'date' are ordered by 'balance' (ascending). The general format is: 'property[,asc|desc]', with 'asc' being the default value. Please note that ordering by multiple fields is not supported in our swagger frontend, but you can test this feature with any HTTP tool of your choice (e.g. postman or DHC). (optional)
try:
# Get daily balances
api_response = api_instance.get_daily_balances(account_ids=account_ids, start_date=start_date, end_date=end_date, with_projection=with_projection, page=page, per_page=per_page, order=order)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->get_daily_balances: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| account_ids | list[int] | A comma-separated list of (non-security) account identifiers. If no accounts are specified, all (non-security) accounts of the current user are regarded. | [optional] |
| start_date | str | A string in the format 'YYYY-MM-DD'. Note that the requested date range [startDate..endDate] may not exceed 365 days. If startDate is not specified, it defaults to the endDate minus one month. | [optional] |
| end_date | str | A string in the format 'YYYY-MM-DD'. Note that the requested date range [startDate..endDate] may not exceed 365 days. If endDate is not specified, it defaults to today's date. | [optional] |
| with_projection | bool | Whether finAPI should project the first and last actually existing balance into the past and future. When passing 'true', then the result will always contain a daily balance for every day of the entire requested date range, even for days before the first actually existing balance, resp. after the last actually existing balance. Those days will have the same balance as the day of the first actual balance, resp. last actual balance, i.e. the first/last balance will be infinitely projected into the past/the future. When passing 'false', then the result will contain daily balances only from the day on where the first actual balance exists for any of the given accounts, and only up to the day where the last actual balance exists for any of the given accounts. Note that when in this case there are no actual balances within the requested date range, then an empty array will be returned. Default value for this parameter is 'true'. | [optional] [default to true] |
| page | int | Result page that you want to retrieve. | [optional] [default to 1] |
| per_page | int | Maximum number of records per page. Can be at most 500. NOTE: Due to its validation and visualization, the swagger frontend might show very low performance, or even crashes, when a service responds with a lot of data. It is recommended to use a HTTP client like Postman or DHC instead of our swagger frontend for service calls with large page sizes. | [optional] [default to 20] |
| order | list[str] | Determines the order of the results. You can order the results by 'date', 'balance', 'income' or 'spending'. The default order for this service is 'date,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/accounts/dailyBalances?order=date,desc&order=balance,asc' will return daily balances ordered by 'date' (descending), where items with the same 'date' are ordered by 'balance' (ascending). The general format is: 'property[,asc | desc]', with 'asc' being the default value. Please note that ordering by multiple fields is not supported in our swagger frontend, but you can test this feature with any HTTP tool of your choice (e.g. postman or DHC). |
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AccountList get_multiple_accounts(ids)
Get multiple accounts
Get a list of multiple bank accounts of the user that is authorized by the access_token. Must pass the accounts' identifiers and the user's access_token. Accounts whose identifiers do not exist or do not relate to the authorized user will not be contained in the result (If this applies to all of the given identifiers, then the result will be an empty list). WARNING: This service is deprecated and will be removed at some point. If you want to get multiple accounts, please instead use the service 'Get and search all accounts' and pass a comma-separated list of identifiers as a parameter 'ids'.
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: finapi_auth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
ids = [56] # list[int] | Comma-separated list of identifiers of requested accounts
try:
# Get multiple accounts
api_response = api_instance.get_multiple_accounts(ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->get_multiple_accounts: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| ids | list[int] | Comma-separated list of identifiers of requested accounts |
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DirectDebitOrderingResponse request_sepa_direct_debit(body)
Request SEPA Direct Debit
Submit a SEPA direct debit order for one or multiple direct debits. Returns an instruction from the bank server that can be displayed to the user (e.g. "Enter TAN"), typically in the language of the bank's country. The order remains valid for execution for only a couple of minutes (the exact validity period depends on the bank). For executing the order, use the /executeSepaDirectDebit service after calling this service. Note that when the order is not executed within the validity period, the bank might take note of that and - if happening too often - ultimately lock the user's online banking access. If there already exists a previously submitted but not yet executed SEPA order for this account (either another direct debit order, or a money transfer order), then that order will be discarded and replaced with the new order that is being created with this service call.
Notes:
• This service cannot be used for the demo account.
• When using a two-step-procedure with flag 'implicitExecute' = true, then this service will immediately execute the direct debit. The response will not contain any challenge message and you won't be required to make a subsequent call to /executeSepaDirectDebit.
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: finapi_auth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
body = swagger_client.RequestSepaDirectDebitParams() # RequestSepaDirectDebitParams | Parameters for a SEPA direct debit request
try:
# Request SEPA Direct Debit
api_response = api_instance.request_sepa_direct_debit(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->request_sepa_direct_debit: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | RequestSepaDirectDebitParams | Parameters for a SEPA direct debit request |
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MoneyTransferOrderingResponse request_sepa_money_transfer(body)
Request SEPA Money Transfer
Submit a SEPA money transfer order for either a single or a collective money transfer. Returns an instruction from the bank server that can be displayed to the user (e.g. "Enter TAN"), typically in the language of the bank's country. The order remains valid for execution for only a couple of minutes (the exact validity period depends on the bank). For executing the order, use the /executeSepaMoneyTransfer service after calling this service. Note that when the order is not executed within the validity period, the bank might take note of that and - if happening too often - ultimately lock the user's online banking access. If there already exists a previously submitted but not yet executed SEPA order for this account (either another money transfer order, or a direct debit order), then that order will be discarded and replaced with the new order that is being created with this service call.
Notes:
• This service cannot be used for the demo account.
• Some banks may require a multi-step authentication, in which case the service will respond with HTTP code 510 and an error message containing a challenge for the user from the bank. You must display the challenge message to the user, and then retry the service call, passing the user's answer to the bank's challenge in the 'challengeResponse' field.
• When using a two-step-procedure with flag 'implicitExecute' = true, then this service will immediately execute the money transfer. The response will not contain any challenge message and you won't be required to make a subsequent call to /executeSepaMoneyTransfer.
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: finapi_auth
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountsApi(swagger_client.ApiClient(configuration))
body = swagger_client.RequestSepaMoneyTransferParams() # RequestSepaMoneyTransferParams | Parameters for a SEPA money transfer request
try:
# Request SEPA Money Transfer
api_response = api_instance.request_sepa_money_transfer(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountsApi->request_sepa_money_transfer: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | RequestSepaMoneyTransferParams | Parameters for a SEPA money transfer request |
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]