strongRESTful_API_for_Account_Information_Services__AIS_and_Payment_Initiation_Services__PISstrongThe_following_pages_give_you_some_general_information_on_how_to_use_our_APIs_brThe_actual_API_services_documentation_then_follows_further_below__You_can_use_
npm install fin_api_accessFinApiAccess - JavaScript client for fin_api_access
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.
You should also check out the Developer Portal for more information. If you need any help with the API, contact support@finapi.io.
{ \"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\": { \"page\": 1, \"perPage\": 20, \"pageCount\": 234, \"totalCount\": 4662 } } - API version: 1.117.0
- Package version: 1.117.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
#### npm
To publish the library as a npm,
please follow the procedure in "Publishing npm packages".
Then install it via:
``shell`
npm install fin_api_access --save
##### Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:
`shell`
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:
`shell`
npm link
Finally, switch to the directory you want to use your fin_api_access from, and run:
`shell`
npm link /path/to/
You should now be able to require('fin_api_access') in javascript files from the directory you ran the last
command above from.
#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/YOUR_USERNAME/fin_api_access
then install it via:
`shell`
npm install YOUR_USERNAME/fin_api_access --save
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify,
perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually
use this library):
`shell`
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:
`javascript`
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Please follow the installation instruction and execute the following JS code:
`javascript
var FinApiAccess = require('fin_api_access');
var defaultClient = FinApiAccess.ApiClient.instance;
// Configure OAuth2 access token for authorization: finapi_auth
var finapi_auth = defaultClient.authentications['finapi_auth'];
finapi_auth.accessToken = "YOUR ACCESS TOKEN"
var api = new FinApiAccess.AccountsApi()
var id = 789; // {Number} Identifier of the account to delete
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.deleteAccount(id, callback);
``
All URIs are relative to https://localhost
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
FinApiAccess.AccountsApi | deleteAccount | DELETE /api/v1/accounts/{id} | Delete an account
FinApiAccess.AccountsApi | deleteAllAccounts | DELETE /api/v1/accounts | Delete all accounts
FinApiAccess.AccountsApi | editAccount | PATCH /api/v1/accounts/{id} | Edit an account
FinApiAccess.AccountsApi | getAccount | GET /api/v1/accounts/{id} | Get an account
FinApiAccess.AccountsApi | getAndSearchAllAccounts | GET /api/v1/accounts | Get and search all accounts
FinApiAccess.AccountsApi | getDailyBalances | GET /api/v1/accounts/dailyBalances | Get daily balances
FinApiAccess.AuthorizationApi | getToken | POST /oauth/token | Get tokens
FinApiAccess.AuthorizationApi | revokeToken | POST /oauth/revoke | Revoke a token
FinApiAccess.BankConnectionsApi | connectInterface | POST /api/v1/bankConnections/connectInterface | Connect a new interface
FinApiAccess.BankConnectionsApi | deleteAccessData | DELETE /api/v1/bankConnections/{id}/aisConsent | Delete a consent
FinApiAccess.BankConnectionsApi | deleteAllBankConnections | DELETE /api/v1/bankConnections | Delete all bank connections
FinApiAccess.BankConnectionsApi | deleteBankConnection | DELETE /api/v1/bankConnections/{id} | Delete a bank connection
FinApiAccess.BankConnectionsApi | editBankConnection | PATCH /api/v1/bankConnections/{id} | Edit a bank connection
FinApiAccess.BankConnectionsApi | getAllBankConnections | GET /api/v1/bankConnections | Get all bank connections
FinApiAccess.BankConnectionsApi | getBankConnection | GET /api/v1/bankConnections/{id} | Get a bank connection
FinApiAccess.BankConnectionsApi | importBankConnection | POST /api/v1/bankConnections/import | Import a new bank connection
FinApiAccess.BankConnectionsApi | removeInterface | POST /api/v1/bankConnections/removeInterface | Remove an interface
FinApiAccess.BankConnectionsApi | updateBankConnection | POST /api/v1/bankConnections/update | Update a bank connection
FinApiAccess.BanksApi | getAndSearchAllBanks | GET /api/v1/banks | Get and search all banks
FinApiAccess.BanksApi | getBank | GET /api/v1/banks/{id} | Get a bank
FinApiAccess.CategoriesApi | createCategory | POST /api/v1/categories | Create a new category
FinApiAccess.CategoriesApi | deleteAllCategories | DELETE /api/v1/categories | Delete all categories
FinApiAccess.CategoriesApi | deleteCategory | DELETE /api/v1/categories/{id} | Delete a category
FinApiAccess.CategoriesApi | editCategory | PATCH /api/v1/categories/{id} | Edit a category
FinApiAccess.CategoriesApi | getAndSearchAllCategories | GET /api/v1/categories | Get and search all categories
FinApiAccess.CategoriesApi | getCashFlows | GET /api/v1/categories/cashFlows | Get cash flows
FinApiAccess.CategoriesApi | getCategory | GET /api/v1/categories/{id} | Get a category
FinApiAccess.CategoriesApi | trainCategorization | POST /api/v1/categories/trainCategorization | Train categorization
FinApiAccess.ClientConfigurationApi | editClientConfiguration | PATCH /api/v1/clientConfiguration | Edit client configuration
FinApiAccess.ClientConfigurationApi | getClientConfiguration | GET /api/v1/clientConfiguration | Get client configuration
FinApiAccess.LabelsApi | createLabel | POST /api/v1/labels | Create a new label
FinApiAccess.LabelsApi | deleteAllLabels | DELETE /api/v1/labels | Delete all labels
FinApiAccess.LabelsApi | deleteLabel | DELETE /api/v1/labels/{id} | Delete a label
FinApiAccess.LabelsApi | editLabel | PATCH /api/v1/labels/{id} | Edit a label
FinApiAccess.LabelsApi | getAndSearchAllLabels | GET /api/v1/labels | Get and search all labels
FinApiAccess.LabelsApi | getLabel | GET /api/v1/labels/{id} | Get a label
FinApiAccess.MandatorAdministrationApi | changeClientCredentials | POST /api/v1/mandatorAdmin/changeClientCredentials | Change client credentials
FinApiAccess.MandatorAdministrationApi | createIbanRules | POST /api/v1/mandatorAdmin/ibanRules | Create IBAN rules
FinApiAccess.MandatorAdministrationApi | createKeywordRules | POST /api/v1/mandatorAdmin/keywordRules | Create keyword rules
FinApiAccess.MandatorAdministrationApi | deleteIbanRules | POST /api/v1/mandatorAdmin/ibanRules/delete | Delete IBAN rules
FinApiAccess.MandatorAdministrationApi | deleteKeywordRules | POST /api/v1/mandatorAdmin/keywordRules/delete | Delete keyword rules
FinApiAccess.MandatorAdministrationApi | deleteUsers | POST /api/v1/mandatorAdmin/deleteUsers | Delete users
FinApiAccess.MandatorAdministrationApi | getIbanRuleList | GET /api/v1/mandatorAdmin/ibanRules | Get IBAN rules
FinApiAccess.MandatorAdministrationApi | getKeywordRuleList | GET /api/v1/mandatorAdmin/keywordRules | Get keyword rules
FinApiAccess.MandatorAdministrationApi | getUserList | GET /api/v1/mandatorAdmin/getUserList | Get user list
FinApiAccess.MocksAndTestsApi | checkCategorization | POST /api/v1/tests/checkCategorization | Check categorization
FinApiAccess.MocksAndTestsApi | mockBatchUpdate | POST /api/v1/tests/mockBatchUpdate | Mock batch update
FinApiAccess.NotificationRulesApi | createNotificationRule | POST /api/v1/notificationRules | Create a new notification rule
FinApiAccess.NotificationRulesApi | deleteAllNotificationRules | DELETE /api/v1/notificationRules | Delete all notification rules
FinApiAccess.NotificationRulesApi | deleteNotificationRule | DELETE /api/v1/notificationRules/{id} | Delete a notification rule
FinApiAccess.NotificationRulesApi | getAndSearchAllNotificationRules | GET /api/v1/notificationRules | Get and search all notification rules
FinApiAccess.NotificationRulesApi | getNotificationRule | GET /api/v1/notificationRules/{id} | Get a notification rule
FinApiAccess.PaymentsApi | createDirectDebit | POST /api/v1/payments/directDebits | Create direct debit
FinApiAccess.PaymentsApi | createMoneyTransfer | POST /api/v1/payments/moneyTransfers | Create money transfer
FinApiAccess.PaymentsApi | getPayments | GET /api/v1/payments | Get payments
FinApiAccess.PaymentsApi | submitPayment | POST /api/v1/payments/submit | Submit payment
FinApiAccess.SecuritiesApi | getAndSearchAllSecurities | GET /api/v1/securities | Get and search all securities
FinApiAccess.SecuritiesApi | getSecurity | GET /api/v1/securities/{id} | Get a security
FinApiAccess.TPPCertificatesApi | createNewCertificate | POST /api/v1/tppCertificates | Create a new certificate
FinApiAccess.TPPCertificatesApi | deleteCertificate | DELETE /api/v1/tppCertificates/{id} | Delete a certificate
FinApiAccess.TPPCertificatesApi | getAllCertificates | GET /api/v1/tppCertificates | Get all certificates
FinApiAccess.TPPCertificatesApi | getCertificate | GET /api/v1/tppCertificates/{id} | Get a certificate
FinApiAccess.TPPCredentialsApi | createTppCredential | POST /api/v1/tppCredentials | Create new TPP credentials
FinApiAccess.TPPCredentialsApi | deleteTppCredential | DELETE /api/v1/tppCredentials/{id} | Delete a set of TPP credentials
FinApiAccess.TPPCredentialsApi | editTppCredential | PATCH /api/v1/tppCredentials/{id} | Edit a set of TPP credentials
FinApiAccess.TPPCredentialsApi | getAllTppCredentials | GET /api/v1/tppCredentials | Get all TPP credentials
FinApiAccess.TPPCredentialsApi | getAndSearchTppAuthenticationGroups | GET /api/v1/tppCredentials/tppAuthenticationGroups | Get all TPP Authentication Groups
FinApiAccess.TPPCredentialsApi | getTppCredential | GET /api/v1/tppCredentials/{id} | Get a set of TPP credentials
FinApiAccess.TransactionsApi | deleteAllTransactions | DELETE /api/v1/transactions | Delete all transactions
FinApiAccess.TransactionsApi | deleteTransaction | DELETE /api/v1/transactions/{id} | Delete a transaction
FinApiAccess.TransactionsApi | editMultipleTransactions | PATCH /api/v1/transactions | Edit multiple transactions
FinApiAccess.TransactionsApi | editTransaction | PATCH /api/v1/transactions/{id} | Edit a transaction
FinApiAccess.TransactionsApi | getAndSearchAllTransactions | GET /api/v1/transactions | Get and search all transactions
FinApiAccess.TransactionsApi | getTransaction | GET /api/v1/transactions/{id} | Get a transaction
FinApiAccess.TransactionsApi | restoreTransaction | POST /api/v1/transactions/{id}/restore | Restore a transaction
FinApiAccess.TransactionsApi | splitTransaction | POST /api/v1/transactions/{id}/split | Split a transaction
FinApiAccess.TransactionsApi | triggerCategorization | POST /api/v1/transactions/triggerCategorization | Trigger categorization
FinApiAccess.UsersApi | createUser | POST /api/v1/users | Create a new user
FinApiAccess.UsersApi | deleteAuthorizedUser | DELETE /api/v1/users | Delete the authorized user
FinApiAccess.UsersApi | deleteUnverifiedUser | DELETE /api/v1/users/{userId} | Delete an unverified user
FinApiAccess.UsersApi | editAuthorizedUser | PATCH /api/v1/users | Edit the authorized user
FinApiAccess.UsersApi | executePasswordChange | POST /api/v1/users/executePasswordChange | Execute password change
FinApiAccess.UsersApi | getAuthorizedUser | GET /api/v1/users | Get the authorized user
FinApiAccess.UsersApi | getVerificationStatus | GET /api/v1/users/verificationStatus | Get a user's verification status
FinApiAccess.UsersApi | requestPasswordChange | POST /api/v1/users/requestPasswordChange | Request password change
FinApiAccess.UsersApi | verifyUser | POST /api/v1/users/verify/{userId} | Verify a user
FinApiAccess.WebFormsApi | getWebForm | GET /api/v1/webForms/{id} | Get a web form
- FinApiAccess.AccessToken
- FinApiAccess.Account
- FinApiAccess.AccountInterface
- FinApiAccess.AccountList
- FinApiAccess.AccountParams
- FinApiAccess.AccountReference
- FinApiAccess.BadCredentialsError
- FinApiAccess.Bank
- FinApiAccess.BankConnection
- FinApiAccess.BankConnectionInterface
- FinApiAccess.BankConnectionList
- FinApiAccess.BankConnectionOwner
- FinApiAccess.BankConsent
- FinApiAccess.BankGroup
- FinApiAccess.BankInterface
- FinApiAccess.BankInterfaceLoginField
- FinApiAccess.CashFlow
- FinApiAccess.CashFlowList
- FinApiAccess.CategorizationCheckResult
- FinApiAccess.CategorizationCheckResults
- FinApiAccess.Category
- FinApiAccess.CategoryParams
- FinApiAccess.ChangeClientCredentialsParams
- FinApiAccess.CheckCategorizationData
- FinApiAccess.CheckCategorizationTransactionData
- FinApiAccess.ClientConfiguration
- FinApiAccess.ClientConfigurationParams
- FinApiAccess.ConnectInterfaceParams
- FinApiAccess.CreateDirectDebitParams
- FinApiAccess.CreateMoneyTransferParams
- FinApiAccess.DailyBalance
- FinApiAccess.DailyBalanceList
- FinApiAccess.DeleteConsent
- FinApiAccess.DirectDebitOrderParams
- FinApiAccess.EditBankConnectionParams
- FinApiAccess.EditCategoryParams
- FinApiAccess.EditTppCredentialParams
- FinApiAccess.ErrorDetails
- FinApiAccess.ErrorMessage
- FinApiAccess.ExecutePasswordChangeParams
- FinApiAccess.IbanRule
- FinApiAccess.IbanRuleIdentifiersParams
- FinApiAccess.IbanRuleList
- FinApiAccess.IbanRuleParams
- FinApiAccess.IbanRulesParams
- FinApiAccess.IdentifierList
- FinApiAccess.ImportBankConnectionParams
- FinApiAccess.KeywordRule
- FinApiAccess.KeywordRuleIdentifiersParams
- FinApiAccess.KeywordRuleList
- FinApiAccess.KeywordRuleParams
- FinApiAccess.KeywordRulesParams
- FinApiAccess.Label
- FinApiAccess.LabelParams
- FinApiAccess.LoginCredential
- FinApiAccess.LoginCredentialResource
- FinApiAccess.MockAccountData
- FinApiAccess.MockBankConnectionUpdate
- FinApiAccess.MockBatchUpdateParams
- FinApiAccess.MoneyTransferOrderParams
- FinApiAccess.MonthlyUserStats
- FinApiAccess.MultiStepAuthenticationCallback
- FinApiAccess.MultiStepAuthenticationChallenge
- FinApiAccess.NewTransaction
- FinApiAccess.NotificationRule
- FinApiAccess.NotificationRuleList
- FinApiAccess.NotificationRuleParams
- FinApiAccess.PageableBankList
- FinApiAccess.PageableCategoryList
- FinApiAccess.PageableIbanRuleList
- FinApiAccess.PageableKeywordRuleList
- FinApiAccess.PageableLabelList
- FinApiAccess.PageablePaymentResources
- FinApiAccess.PageableSecurityList
- FinApiAccess.PageableTppAuthenticationGroupResources
- FinApiAccess.PageableTppCertificateList
- FinApiAccess.PageableTppCredentialResources
- FinApiAccess.PageableTransactionList
- FinApiAccess.PageableUserInfoList
- FinApiAccess.Paging
- FinApiAccess.PasswordChangingResource
- FinApiAccess.Payment
- FinApiAccess.RemoveInterfaceParams
- FinApiAccess.RequestPasswordChangeParams
- FinApiAccess.Security
- FinApiAccess.SplitTransactionsParams
- FinApiAccess.SubTransactionParams
- FinApiAccess.SubmitPaymentParams
- FinApiAccess.TppAuthenticationGroup
- FinApiAccess.TppCertificate
- FinApiAccess.TppCertificateParams
- FinApiAccess.TppCredentials
- FinApiAccess.TppCredentialsParams
- FinApiAccess.TrainCategorizationData
- FinApiAccess.TrainCategorizationTransactionData
- FinApiAccess.Transaction
- FinApiAccess.TriggerCategorizationParams
- FinApiAccess.TwoStepProcedure
- FinApiAccess.UpdateBankConnectionParams
- FinApiAccess.UpdateMultipleTransactionsParams
- FinApiAccess.UpdateResult
- FinApiAccess.UpdateTransactionsParams
- FinApiAccess.User
- FinApiAccess.UserCreateParams
- FinApiAccess.UserIdentifiersList
- FinApiAccess.UserIdentifiersParams
- FinApiAccess.UserInfo
- FinApiAccess.UserUpdateParams
- FinApiAccess.VerificationStatusResource
- FinApiAccess.WebForm
- Type: OAuth
- Flow: accessCode
- Authorization URL: /oauth/authorize
- Scopes:
- all: modify any sources