diff --git a/README.md b/README.md index 6068e6a..f07510a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,16 @@ -# Go finAPI +# Go finAPI > This package provides a finAPI SDK for Go. It was created via [swagger-codegen](https://github.com/swagger-api/swagger-codegen) as described in [the finAPI documentation](https://finapi.zendesk.com/hc/en-us/articles/219390177-SDK-creation-for-finAPI-). Addionally some wrapper code was added to improve the usability. -- API version: v1.79.0 +- API version: v1.93.0 - Package version: 1.0.0 - Build package: io.swagger.codegen.languages.GoClientCodegen +- [Usage](#usage) +- [Documentation for API Endpoints](#documentation-for-api-endpoints) +- [Documentation For Models](#documentation-for-models) +- [How to Update This SDK](#how-to-update-this-sdk) + ## Usage ```go import ( @@ -192,13 +197,14 @@ Class | Method | HTTP request | Description - [ExecuteSepaDirectDebitParams](docs/ExecuteSepaDirectDebitParams.md) - [ExecuteSepaMoneyTransferParams](docs/ExecuteSepaMoneyTransferParams.md) - [IbanRule](docs/IbanRule.md) + - [IbanRuleIdentifiersParams](docs/IbanRuleIdentifiersParams.md) - [IbanRuleList](docs/IbanRuleList.md) - [IbanRuleParams](docs/IbanRuleParams.md) - [IbanRulesParams](docs/IbanRulesParams.md) - [IdentifierList](docs/IdentifierList.md) - - [IdentifiersParams](docs/IdentifiersParams.md) - [ImportBankConnectionParams](docs/ImportBankConnectionParams.md) - [KeywordRule](docs/KeywordRule.md) + - [KeywordRuleIdentifiersParams](docs/KeywordRuleIdentifiersParams.md) - [KeywordRuleList](docs/KeywordRuleList.md) - [KeywordRuleParams](docs/KeywordRuleParams.md) - [KeywordRulesParams](docs/KeywordRulesParams.md) @@ -268,3 +274,33 @@ Class | Method | HTTP request | Description - [UserUpdateParams](docs/UserUpdateParams.md) - [VerificationStatusResource](docs/VerificationStatusResource.md) - [WebForm](docs/WebForm.md) + +## How to Update This SDK +1. Download the newest version of the official SDK from [docs.finapi.io](https://docs.finapi.io). For that click the download button on the top of the page and select "go" as language. +2. Save the zip file you get there to some place on your PC and extract it. Open the folder `go-client`. +3. Replace the folders `docs` and `api` in the current FastBill finAPI SDK repository with the new ones that you downloaded. +4. Delete everything in the current `model` folder and then copy all files starting with `model_` from the freshly downloaded SDK to the repositories `model` folder. +5. Copy all files besides the ones with `model_`, `README.md` and `git_push.sh` and use them to replace the files on root level in the current repository. +6. Rename all occurances of `package swagger` to `package finapi` in the repository. +7. Add the import statement `. "github.com/fastbill/go-finapi/v3/model"` to all the files in the root folder of the repository besides `configuration.go`, `finapi.go`, `client.go` and `response.go`. When you save the file your IDE should also automatically fix all Go formatting errors in the file. Also some missing import statements for the package `optional` might be added in this process. +8. In the file `client.go` make sure to keep the following change for the serialization of the Swagger error (either revert the change from copying the file or just paste in the old version again): + ```go + func (e GenericSwaggerError) Error() string { + return e.error + ", body: " + string(e.body) + } + ``` +9. In the file `client.go` make sure to keep the custom HTTP client with the timeout, not the DefaultClient that you get from the fresh SDK download. + ```go + func NewAPIClient(cfg *Configuration) *APIClient { + if cfg.HTTPClient == nil { + cfg.HTTPClient = &http.Client{ + // The AWS ALB will terminate the connection (e.g. to legacy) after 60s so there is no point + // in waiting longer than that for finAPI. Even when they would respond later we could not send + // the response anymore. + Timeout: 55 * time.Second, + } + } + // ... + ``` +10. From the `README.md` file in the downloaded SDK copy the sections `Documentation for API Endpoints` and `Documentation For Models` and use them to replace those sections in the repository `README.md` file. Also update the API version mentioned at the top of the readme. +11. Review the changes in the Git diff before commiting them. Files in `docs` folder can be commited without thourough checking since they only contain text changes. \ No newline at end of file diff --git a/api/swagger.yaml b/api/swagger.yaml index bda8554..9efdeb5 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -2,7 +2,7 @@ swagger: "2.0" info: description: "finAPI RESTful Services" - version: "v1.79.0" + version: "v1.93.0" title: "finAPI RESTful Services" basePath: "/" tags: @@ -142,19 +142,19 @@ paths: x-exportParamName: "MaxBalance" x-optionalDataType: "Float32" responses: - 200: + "200": description: "List of requested accounts" schema: $ref: "#/definitions/AccountList" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -177,25 +177,25 @@ paths: operationId: "deleteAllAccounts" parameters: [] responses: - 200: + "200": description: "List of identifiers of deleted accounts" schema: $ref: "#/definitions/IdentifierList" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "No action was performed as at least one account is currently\ \ being imported, updated (either by the user or by finAPI's automatic\ \ batch update), or because the categorization of transactions is performed." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -272,21 +272,22 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" - name: "order" @@ -309,31 +310,31 @@ paths: collectionFormat: "multi" x-exportParamName: "Order" responses: - 200: + "200": description: "List of requested daily balances" schema: $ref: "#/definitions/DailyBalanceList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Account(s) not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "Invalid date range (e.g. endDate < startDate)" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -364,28 +365,28 @@ paths: $ref: "#/definitions/ExecuteSepaDirectDebitParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Response for the SEPA Direct Debit execute" schema: $ref: "#/definitions/PaymentExecutionResponse" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role or your client does not have\ \ payments enabled (see client configuration)" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Account not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "ILLEGAL_ENTITY_STATE if no pending SEPA direct debit order\ \ exists for the account; BANK_SERVER_REJECTION if the bank server responded\ \ with an error message when finAPI tried to execute the direct debit\ @@ -394,13 +395,13 @@ paths: \ useful information." schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "SEPA Direct Debit cannot get executed at the moment as the\ \ update is currently being executed (either by the user or by finAPI's\ \ automatic batch update)." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -431,28 +432,28 @@ paths: $ref: "#/definitions/ExecuteSepaMoneyTransferParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Response for the SEPA Money Transfer execute" schema: $ref: "#/definitions/PaymentExecutionResponse" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role or your client does not have\ \ payments enabled (see client configuration)" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Account not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "ILLEGAL_ENTITY_STATE if no pending SEPA money transfer order\ \ exists for the account; BANK_SERVER_REJECTION if the bank server responded\ \ with an error message when finAPI tried to execute the money transfer\ @@ -461,13 +462,13 @@ paths: \ useful information." schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "SEPA Money Transfer cannot get executed at the moment as the\ \ update is currently being executed (either by the user or by finAPI's\ \ automatic batch update)." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -517,28 +518,28 @@ paths: $ref: "#/definitions/RequestSepaDirectDebitParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Response for the SEPA Direct Debit request" schema: $ref: "#/definitions/DirectDebitOrderingResponse" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role or your client does not have\ \ payments enabled (see client configuration)" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Account not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "ILLEGAL_FIELD_VALUE if SEPA purpose code is specified incorrectly;
ILLEGAL_ENTITY_STATE\ \ if no PIN has been specified and finAPI has no PIN stored for the account's\ \ bank connection or if the account used for the request is DEPRECATED/not\ @@ -558,23 +559,23 @@ paths: \ from the bank server that contains useful information for the user." schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "SEPA Direct Debit cannot get requested at the moment as the\ \ update is currently being executed (either by the user or by finAPI's\ \ automatic batch update)." schema: $ref: "#/definitions/ErrorMessage" - 451: + "451": description: "In case the user must enter credentials and/or select a two-step-procedure\ \ within finAPI's web form. See: finAPI's Web Form Flow" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" - 501: + "501": description: "The given bank is currently not supported by finAPI" schema: $ref: "#/definitions/ErrorMessage" @@ -629,28 +630,28 @@ paths: $ref: "#/definitions/RequestSepaMoneyTransferParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Response for the SEPA Money Transfer request" schema: $ref: "#/definitions/MoneyTransferOrderingResponse" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role or your client does not have\ \ payments enabled (see client configuration)" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Account not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "ILLEGAL_ENTITY_STATE if no PIN has been specified and finAPI\ \ has no PIN stored for the account's bank connection or if the account\ \ used for the request is DEPRECATED/not found on bank side;
UNSUPPORTED_ORDER\ @@ -674,27 +675,27 @@ paths: \ incorrectly; if SEPA purpose code is specified incorrectly" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "SEPA Money Transfer cannot get requested at the moment as\ \ the update is currently being executed (either by the user or by finAPI's\ \ automatic batch update)." schema: $ref: "#/definitions/ErrorMessage" - 451: + "451": description: "In case the user must enter credentials and/or select a two-step-procedure\ \ within finAPI's web form. See: finAPI's Web Form Flow" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" - 501: + "501": description: "The given bank is currently not supported by finAPI" schema: $ref: "#/definitions/ErrorMessage" - 510: + "510": description: "In case the bank requires an additional authentication by\ \ the user. The error's message will contain instructions for the user.\ \ Redo the service call and pass the user's answer to the challenge in\ @@ -734,23 +735,23 @@ paths: pattern: "[\\d]+,[\\d,]+" x-exportParamName: "Ids" responses: - 200: + "200": description: "List of requested accounts" schema: $ref: "#/definitions/AccountList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -778,27 +779,27 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Requested account" schema: $ref: "#/definitions/Account" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Account not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -832,27 +833,27 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Account deleted (empty response body)" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Account not found" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "Account cannot get deleted at the moment as it is currently\ \ being imported or updated (either by the user or by finAPI's automatic\ \ batch update), or because the categorization of transactions is performed." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -887,35 +888,35 @@ paths: $ref: "#/definitions/AccountParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Edited account" schema: $ref: "#/definitions/Account" - 400: + "400": description: "MISSING_FIELD if neither a name, nor a type, nor the 'isNew'\ \ flag were specified; UNKNOWN_ENTITY if the given account type id does\ \ not exist" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Account not found" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "Account cannot get edited at the moment as it is currently\ \ being imported or updated (either by the user or by finAPI's automatic\ \ batch update)." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -949,19 +950,19 @@ paths: collectionFormat: "multi" x-exportParamName: "Ids" responses: - 200: + "200": description: "List of requested bank connections" schema: $ref: "#/definitions/BankConnectionList" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -983,26 +984,26 @@ paths: operationId: "deleteAllBankConnections" parameters: [] responses: - 200: + "200": description: "List of identifiers of deleted bank connections" schema: $ref: "#/definitions/IdentifierList" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "No action was performed at the moment as at least one bank\ \ connection is being imported, updated (either by the user or by finAPI's\ \ automatic batch update), or because the categorization of transactions\ \ is currently performed." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -1046,23 +1047,23 @@ paths: $ref: "#/definitions/ConnectInterfaceParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Bank connection with the new interface" schema: $ref: "#/definitions/BankConnection" - 400: + "400": description: "Bad Request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "UNKNOWN_ENTITY if the specified bank connection identifier\ \ does not exist;
ILLEGAL_FIELD_VALUE:
- if the given credentials\ \ do not contain at least one non-secret and one secret field;
-\ @@ -1083,21 +1084,21 @@ paths: \ field was set, but there is no pending challenge for this bank connection;
" schema: $ref: "#/definitions/ErrorMessage" - 451: + "451": description: "In case the user must enter credentials within finAPI's web\ \ form. See: finAPI's Web Form Flow" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" - 501: + "501": description: "This bank is currently not supported by finAPI" schema: $ref: "#/definitions/ErrorMessage" - 510: + "510": description: "In case the bank requires an additional authentication by\ \ the user. The error's 'multiStepAuthentication' field contains further\ \ instructions. The actual MSA flow depends on the bank and may contain\ @@ -1110,7 +1111,7 @@ paths: \ means that the bank has requested a challenge code for the previously\ \ given TSP (SCA). This status can be completed by setting the 'challengeResponse'\ \ field.
When the web form flow is used, the user should submit the\ - \ challenge response for the challenge message shown by the web form.

REDIRECT_REQUIRES\ + \ challenge response for the challenge message shown by the web form.

REDIRECT_REQUIRED\ \ means that the user must be redirected to the bank's website, where\ \ the authentication can be finished.
When the web form flow is used,\ \ the user should visit the web form, get a redirect to the bank's website,\ @@ -1160,8 +1161,28 @@ paths: \ for the demo bank connection, i.e. when importing the demo bank connection,\ \ you will always get the transactions for its account. You can enable multi-step\ \ authentication for the demo bank connection by setting the bank connection\ - \ name to \"MSA\".

For a more in-depth understanding of the import\ - \ process, please also read this article on our Dev Portal:
The XS2A interface could also be used to initiate\ + \ a demo connection import.
The finAPI demo XS2A allows you to download\ + \ a test account by using the 'import' or 'connectInterface' services - in\ + \ general, this XS2A demo account is the FINTS_SERVER demo account, as it\ + \ has the same account number and origin of balances and transactions.
Keep\ + \ in mind, that calling an XS2A demo connection import will result as a newly\ + \ created bank connection, when the 'connectInterface' service attaches the\ + \ XS2A demo account to an existing demo connection.
Passing the login\ + \ credentials is not obligated only for redirect banks, however the demo bank\ + \ works without any given set of credentials for the XS2A interface. The old\ + \ API credentials fields (bankingUserId, bankingCustomerId, bankingPin) are\ + \ DEPRECATED and temporarily mapped on the new credentials data structure,\ + \ allowing you to use them within the XS2A import. This is not recommended,\ + \ as those fields are going to be removed at some point later.
If you\ + \ are looking to test the XS2A SCA (Strong Customer Authentication, or MSA\ + \ (Multi-Step Authentication) in the finAPI context), you need to pass the\ + \ bank connection name as \"MSA\" to trigger the SCA flow or as 'DECOUPLED-AUTH'\ + \ to simulate decoupled authentication. To get better understanding about\ + \ the Multi-Step Authentication, please refer to the 'Error Messages' section\ + \ of the swagger documentation.

For a more in-depth understanding\ + \ of the import process, please also read this article on our Dev Portal:\ + \ Import & Update of Bank Connections / Accounts

NOTE:\ \ Depending on your license, this service may respond with HTTP code 451,\ \ containing an error message with a identifier of web form in it. In addition\ @@ -1171,10 +1192,9 @@ paths: \ refer to this article: finAPI's Web Form Flow

Attention: Due\ \ to changes on the bank's side we have been forced to limit the maxDaysForDownload\ - \ field to 89 days. Now any import or update of a bank connection will only\ - \ fetch the last three months of transactions per account, regardless if maxDaysForDownload\ - \ is defined or not. We're working of fixing this behaviour by implementing\ - \ the multi step authentication workflow for FinTS." + \ field to 89 days to reduce the risk of strong customer authentication (SCA)\ + \ requests. If you have implemented the SCA flow, please contact us, so that\ + \ we can remove this limitation from your client." operationId: "importBankConnection" parameters: - in: "body" @@ -1185,23 +1205,23 @@ paths: $ref: "#/definitions/ImportBankConnectionParams" x-exportParamName: "Body" responses: - 201: + "201": description: "Imported bank connection" schema: $ref: "#/definitions/BankConnection" - 400: + "400": description: "Bad Request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "UNKNOWN_ENTITY if the specified bank identifier does not exist;
ENTITY_EXISTS\ \ if such a bank connection already exists;
ILLEGAL_FIELD_VALUE:
\ \ - if the given credentials do not contain at least one non-secret and\ @@ -1224,21 +1244,21 @@ paths: \ challenge for this bank connection;
" schema: $ref: "#/definitions/ErrorMessage" - 451: + "451": description: "In case the user must enter credentials within finAPI's web\ \ form. See: finAPI's Web Form Flow" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" - 501: + "501": description: "This bank is currently not supported by finAPI" schema: $ref: "#/definitions/ErrorMessage" - 510: + "510": description: "In case the bank requires an additional authentication by\ \ the user. The error's 'multiStepAuthentication' field contains further\ \ instructions. The actual MSA flow depends on the bank and may contain\ @@ -1251,7 +1271,7 @@ paths: \ means that the bank has requested a challenge code for the previously\ \ given TSP (SCA). This status can be completed by setting the 'challengeResponse'\ \ field.
When the web form flow is used, the user should submit the\ - \ challenge response for the challenge message shown by the web form.

REDIRECT_REQUIRES\ + \ challenge response for the challenge message shown by the web form.

REDIRECT_REQUIRED\ \ means that the user must be redirected to the bank's website, where\ \ the authentication can be finished.
When the web form flow is used,\ \ the user should visit the web form, get a redirect to the bank's website,\ @@ -1288,27 +1308,27 @@ paths: $ref: "#/definitions/RemoveInterfaceParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Bank connection interface removed (empty response body)" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Bank connection interface not found" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "Bank connection interface cannot be removed at the moment\ \ as it is currently being imported or updated (either by the user or\ \ by finAPI's automatic batch update)." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -1324,7 +1344,12 @@ paths: summary: "Update a bank connection" description: "Update an existing bank connection of the user that is authorized\ \ by the access_token. Downloads and imports the current account balances\ - \ and new transactions. Must pass the connection's identifier and the user's\ + \ and new transactions. Note that if the bank connection has several interfaces\ + \ and some of its accounts was previously imported or updated via an interface\ + \ which have higher priority than the interface used in the current update,\ + \ then balances and transactions will not be downloaded for such accounts\ + \ (The XS2A interface has the highest priority, followed by FINTS_SERVER and\ + \ finally WEB_SCRAPER). Must pass the connection's identifier and the user's\ \ access_token. For more information about the processes of authentication,\ \ data download and transactions categorization, see POST /bankConnections/import.\ \ Note that supported two-step-procedures are updated as well. It may unset\ @@ -1344,11 +1369,11 @@ paths: \ to finAPI's web form. For a detailed explanation of the Web Form Flow, please\ \ refer to this article: finAPI's Web Form Flow

Attention: Due\ - \ to changes on the bank's side we have been forced to limit the maxDaysForDownload\ - \ field to 89 days. Now any import or update of a bank connection will only\ - \ fetch the last three months of transactions per account, regardless if maxDaysForDownload\ - \ is defined or not. We're working of fixing this behaviour by implementing\ - \ the multi step authentication workflow for FinTS." + \ to changes on the bank's side we have been forced to limit the transaction\ + \ download time frame to 89 days. Now any update of a bank connection will\ + \ fetch the last three months of transactions per account. If the last successful\ + \ update was more than 3 months ago, an adjusting entry ('Zwischensaldo' transaction)\ + \ will be created." operationId: "updateBankConnection" parameters: - in: "body" @@ -1359,27 +1384,27 @@ paths: $ref: "#/definitions/UpdateBankConnectionParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Bank connection that the update was triggered for" schema: $ref: "#/definitions/BankConnection" - 400: + "400": description: "Bad Request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Bank connection not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "MISSING_FIELD if the credentials (stored in finAPI and provided\ \ in the request) do not contain at least one non-secret and one secret\ \ field;
ILLEGAL_FIELD_VALUE:
- if any of the specified credentials\ @@ -1399,30 +1424,31 @@ paths: \ were not correct or that the connection is not activated for online\ \ banking);
NO_EXISTING_CHALLENGE in case the 'challengeResponse'\ \ field was set, but there is no pending challenge for this bank connection;
INVALID_CONSENT\ - \ if access data of the bank connection has already expired." + \ if access data of the bank connection has already expired. Please retry\ + \ the call to request a new consent." schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "Bank connection cannot get updated at the moment as it is\ \ currently being imported or updated (either by the user or by finAPI's\ \ automatic batch update)." schema: $ref: "#/definitions/ErrorMessage" - 451: + "451": description: "In case the user must enter credentials within finAPI's web\ \ form. See: finAPI's Web Form Flow" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" - 501: + "501": description: "This bank is currently not supported by finAPI" schema: $ref: "#/definitions/ErrorMessage" - 510: + "510": description: "In case the bank requires an additional authentication by\ \ the user. The error's 'multiStepAuthentication' field contains further\ \ instructions. The actual MSA flow depends on the bank and may contain\ @@ -1435,7 +1461,7 @@ paths: \ means that the bank has requested a challenge code for the previously\ \ given TSP (SCA). This status can be completed by setting the 'challengeResponse'\ \ field.
When the web form flow is used, the user should submit the\ - \ challenge response for the challenge message shown by the web form.

REDIRECT_REQUIRES\ + \ challenge response for the challenge message shown by the web form.

REDIRECT_REQUIRED\ \ means that the user must be redirected to the bank's website, where\ \ the authentication can be finished.
When the web form flow is used,\ \ the user should visit the web form, get a redirect to the bank's website,\ @@ -1482,23 +1508,23 @@ paths: pattern: "[\\d]+,[\\d,]+" x-exportParamName: "Ids" responses: - 200: + "200": description: "List of requested bank connections" schema: $ref: "#/definitions/BankConnectionList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -1526,27 +1552,27 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Requested bank connection" schema: $ref: "#/definitions/BankConnection" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Bank connection not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -1578,28 +1604,28 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Bank connection deleted (empty response body)" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Bank connection not found" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "Bank connection cannot get deleted at the moment as it is\ \ currently being imported or updated (either by the user or by finAPI's\ \ automatic batch update), or because the categorization of transactions\ \ is currently performed." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -1640,27 +1666,27 @@ paths: $ref: "#/definitions/EditBankConnectionParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Edited bank connection" schema: $ref: "#/definitions/BankConnection" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Bank connection not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "INVALID_TWO_STEP_PROCEDURE:
if submitted two-step-procedure\ \ does not exist for the user. Please use one of the procedures that are\ \ listed in the bank connection;
ILLEGAL_FIELD_VALUE:
- if the\ @@ -1670,19 +1696,19 @@ paths: \ interface that is not connected to the bank;" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "Bank connection cannot get edited at the moment as it is currently\ \ being imported or updated (either by the user or by finAPI's automatic\ \ batch update)." schema: $ref: "#/definitions/ErrorMessage" - 451: + "451": description: "In case the user must enter credentials within finAPI's web\ \ form. See: finAPI's Web Form Flow" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -1818,21 +1844,22 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" - name: "order" @@ -1854,23 +1881,23 @@ paths: collectionFormat: "multi" x-exportParamName: "Order" responses: - 200: + "200": description: "List of requested banks" schema: $ref: "#/definitions/PageableBankList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "You are not allowed to call this service" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -1907,23 +1934,23 @@ paths: pattern: "[\\d]+,[\\d,]+" x-exportParamName: "Ids" responses: - 200: + "200": description: "List of requested banks" schema: $ref: "#/definitions/BankList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "You are not allowed to call this service" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -1952,27 +1979,27 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Requested Bank" schema: $ref: "#/definitions/Bank" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "You are not allowed to call this service" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Bank not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2033,21 +2060,22 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" - name: "order" @@ -2069,23 +2097,23 @@ paths: collectionFormat: "multi" x-exportParamName: "Order" responses: - 200: + "200": description: "List of requested categories" schema: $ref: "#/definitions/PageableCategoryList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2112,28 +2140,28 @@ paths: $ref: "#/definitions/CategoryParams" x-exportParamName: "Body" responses: - 201: + "201": description: "Created category" schema: $ref: "#/definitions/Category" - 400: + "400": description: "The category name is too long. The maximum length for a category\ \ name is 128." schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "UNKNOWN_ENTITY if the parent category does not exist." schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "ILLEGAL_ENTITY_STATE if The given parentId references a sub-category\ \ instead of a main category (Multi-level sub-categories are not supported);\ \
ENTITY_EXISTS if a category with that name already exists.
NOTE:\ @@ -2150,7 +2178,7 @@ paths: \ get created" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2169,23 +2197,23 @@ paths: operationId: "deleteAllCategories" parameters: [] responses: - 200: + "200": description: "List of identifiers of deleted categories" schema: $ref: "#/definitions/IdentifierList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2425,27 +2453,27 @@ paths: collectionFormat: "multi" x-exportParamName: "Order" responses: - 200: + "200": description: "List of requested cash flows" schema: $ref: "#/definitions/CashFlowList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Category not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2478,29 +2506,29 @@ paths: $ref: "#/definitions/TrainCategorizationData" x-exportParamName: "Body" responses: - 200: + "200": description: "Categorization rules updated (empty response body)" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Category not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "The number of transactions exceeds the limit of 100." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2537,23 +2565,23 @@ paths: pattern: "[\\d]+,[\\d,]+" x-exportParamName: "Ids" responses: - 200: + "200": description: "List of requested categories" schema: $ref: "#/definitions/CategoryList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2582,27 +2610,27 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Requested category" schema: $ref: "#/definitions/Category" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Category not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2631,29 +2659,29 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Category was deleted successfully (empty response body)" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Category not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "Category cannot be deleted" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2686,31 +2714,31 @@ paths: $ref: "#/definitions/EditCategoryParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Edited transaction category" schema: $ref: "#/definitions/Category" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Category not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "Category cannot be edited" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2729,23 +2757,23 @@ paths: operationId: "getClientConfiguration" parameters: [] responses: - 200: + "200": description: "Current client configuration" schema: $ref: "#/definitions/ClientConfiguration" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2772,23 +2800,23 @@ paths: $ref: "#/definitions/ClientConfigurationParams" x-exportParamName: "Body" responses: - 200: + "200": description: "New client configuration" schema: $ref: "#/definitions/ClientConfiguration" - 400: + "400": description: "Bad request (e.g. invalid callback URL)" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2839,21 +2867,22 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" - name: "order" @@ -2871,23 +2900,23 @@ paths: collectionFormat: "multi" x-exportParamName: "Order" responses: - 200: + "200": description: "List of requested labels" schema: $ref: "#/definitions/PageableLabelList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2923,28 +2952,28 @@ paths: $ref: "#/definitions/LabelParams" x-exportParamName: "Body" responses: - 201: + "201": description: "Created label" schema: $ref: "#/definitions/Label" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "ILLEGAL_FIELD_VALUE if the given label name is too long;\ \ ENTITY_EXISTS if a label with the given name already exists" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -2962,23 +2991,23 @@ paths: operationId: "deleteAllLabels" parameters: [] responses: - 200: + "200": description: "List of identifiers of deleted labels" schema: $ref: "#/definitions/IdentifierList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3014,23 +3043,23 @@ paths: pattern: "[\\d]+,[\\d,]+" x-exportParamName: "Ids" responses: - 200: + "200": description: "List of requested labels" schema: $ref: "#/definitions/LabelList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3058,27 +3087,27 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Requested label" schema: $ref: "#/definitions/Label" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Label not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3104,25 +3133,25 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Label deleted (empty response body)" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Label not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3156,32 +3185,32 @@ paths: $ref: "#/definitions/LabelParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Edited label" schema: $ref: "#/definitions/Label" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Label not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "ILLEGAL_FIELD_VALUE if the given label name is too long;\ \ ENTITY_EXISTS if a label with the given name already exists" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3211,27 +3240,27 @@ paths: $ref: "#/definitions/ChangeClientCredentialsParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Client secret successfully changed (empty response body)" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role. Make sure you're authorized\ \ as the mandator admin client." schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "The given 'clientId' is unknown or the given 'oldClientSecret'\ \ is incorrect" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3267,24 +3296,24 @@ paths: $ref: "#/definitions/UserIdentifiersParams" x-exportParamName: "Body" responses: - 200: + "200": description: "List of identifiers of deleted and not deleted users" schema: $ref: "#/definitions/UserIdentifiersList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role. Make sure you're authorized\ \ as the mandator admin client." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3407,6 +3436,16 @@ paths: format: "int32" x-exportParamName: "MinBankConnectionCountInMonthlyStats" x-optionalDataType: "Int32" + - name: "userId" + in: "query" + description: "The identifier of a user to search for. If specified, then only\ + \ the user with the given id will be regarded. If no user can be found for\ + \ the passed userId (because the user was deleted or his username was misspelled),\ + \ then the result list will be empty." + required: false + type: "string" + x-exportParamName: "UserId" + x-optionalDataType: "String" - name: "isDeleted" in: "query" description: "If NOT specified, then the service will regard both active and\ @@ -3432,21 +3471,22 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" - name: "order" @@ -3462,24 +3502,24 @@ paths: collectionFormat: "multi" x-exportParamName: "Order" responses: - 200: + "200": description: "Requested users list" schema: $ref: "#/definitions/PageableUserInfoList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role. Make sure you're authorized\ \ as the mandator admin client." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3503,42 +3543,43 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" responses: - 200: + "200": description: "Requested IBAN rules" schema: $ref: "#/definitions/PageableIbanRuleList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role. Make sure you're authorized\ \ as the mandator admin client." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3576,31 +3617,31 @@ paths: $ref: "#/definitions/IbanRulesParams" x-exportParamName: "Body" responses: - 201: + "201": description: "Created IBAN rules" schema: $ref: "#/definitions/IbanRuleList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Category not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "ENTITY_EXISTS if at least one of the given rules already exists" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3624,31 +3665,31 @@ paths: \ is 100." required: true schema: - $ref: "#/definitions/IdentifiersParams" + $ref: "#/definitions/IbanRuleIdentifiersParams" x-exportParamName: "Body" responses: - 200: + "200": description: "List of identifiers of deleted IBAN rules" schema: $ref: "#/definitions/IdentifierList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role. Make sure you're authorized\ \ as the mandator admin client." schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "IBAN rule not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3672,42 +3713,43 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" responses: - 200: + "200": description: "Requested keyword rules" schema: $ref: "#/definitions/PageableKeywordRuleList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role. Make sure you're authorized\ \ as the mandator admin client." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3748,32 +3790,32 @@ paths: $ref: "#/definitions/KeywordRulesParams" x-exportParamName: "Body" responses: - 201: + "201": description: "Created keyword rules" schema: $ref: "#/definitions/KeywordRuleList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Category not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "ENTITY_EXISTS if at least one of the given rules already exists;\ \ ILLEGAL_FIELD_VALUE if the request contains incorrect keywords." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3797,31 +3839,31 @@ paths: \ is 100." required: true schema: - $ref: "#/definitions/IdentifiersParams" + $ref: "#/definitions/KeywordRuleIdentifiersParams" x-exportParamName: "Body" responses: - 200: + "200": description: "List of identifiers of deleted keyword rules" schema: $ref: "#/definitions/IdentifierList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role. Make sure you're authorized\ \ as the mandator admin client." schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Keyword rule not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3881,23 +3923,23 @@ paths: x-exportParamName: "IncludeDetails" x-optionalDataType: "Bool" responses: - 200: + "200": description: "List of requested notification rules" schema: $ref: "#/definitions/NotificationRuleList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "You are not allowed to call this service" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3936,35 +3978,35 @@ paths: $ref: "#/definitions/NotificationRuleParams" x-exportParamName: "Body" responses: - 201: + "201": description: "Created notification rule" schema: $ref: "#/definitions/NotificationRule" - 400: + "400": description: "Bad Request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "You are not allowed to call this service" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "ILLEGAL_FIELD_VALUE if the given 'triggerEvent' does not match\ \ any of the known constants, or if the 'params' field contains illegal\ \ parameters for the respective trigger event; ENTITY_EXISTS if such a\ \ notification rule already exists" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "Notification rules cannot get created at the moment as finAPI's\ \ automatic batch update is currently being executed" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -3982,24 +4024,24 @@ paths: operationId: "deleteAllNotificationRules" parameters: [] responses: - 200: + "200": description: "List of identifiers of deleted notification rules" schema: $ref: "#/definitions/IdentifierList" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "You are not allowed to call this service" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "Notification rules cannot get deleted at the moment as finAPI's\ \ automatic batch update is currently being executed" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4027,27 +4069,27 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Requested notification rule" schema: $ref: "#/definitions/NotificationRule" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "You are not allowed to call this service" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Notification rule not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4074,26 +4116,26 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Notification rule deleted (empty response body)" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "You are not allowed to call this service" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Notification rule not found" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "Notification rules cannot get deleted at the moment as finAPI's\ \ automatic batch update is currently being executed" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4158,21 +4200,22 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" - name: "order" @@ -4188,23 +4231,23 @@ paths: collectionFormat: "multi" x-exportParamName: "Order" responses: - 200: + "200": description: "List of requested payments" schema: $ref: "#/definitions/PageablePaymentResources" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Authentication required" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "Unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4268,21 +4311,22 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" - name: "order" @@ -4303,23 +4347,23 @@ paths: collectionFormat: "multi" x-exportParamName: "Order" responses: - 200: + "200": description: "List of requested securities" schema: $ref: "#/definitions/PageableSecurityList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4358,23 +4402,23 @@ paths: pattern: "[\\d]+,[\\d,]+" x-exportParamName: "Ids" responses: - 200: + "200": description: "List of requested securities" schema: $ref: "#/definitions/SecurityList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4404,27 +4448,27 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Requested security" schema: $ref: "#/definitions/Security" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Security not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4454,23 +4498,23 @@ paths: $ref: "#/definitions/CheckCategorizationData" x-exportParamName: "Body" responses: - 200: + "200": description: "List of given transaction IDs, mapped to their found category" schema: $ref: "#/definitions/CategorizationCheckResults" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 422: + "422": description: "The number of transactions exceeds the maximum limit" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4533,28 +4577,28 @@ paths: $ref: "#/definitions/MockBatchUpdateParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Mock batch update has been started (empty response body)" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "You are not allowed to call this service (for instance, because\ \ automatic update is enabled for the user, or because you are trying\ \ to call the service on a live environment)" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Bank connection or account not found; or account does not\ \ belong to the bank connection it is nested in." schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "At least one of the given account identifiers refers to a\ \ security account; or at least one of the given bank connections is currently\ \ locked due to another running update; or not all given bank connections\ @@ -4562,7 +4606,7 @@ paths: \ 1000." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4587,42 +4631,43 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" responses: - 200: + "200": description: "Requested certificates" schema: $ref: "#/definitions/PageableTppCertificateList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role. Make sure you're authorized\ \ as the mandator admin client." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4649,28 +4694,28 @@ paths: $ref: "#/definitions/TppCertificateParams" x-exportParamName: "Body" responses: - 200: + "200": description: "An identifier of the stored certificate" schema: $ref: "#/definitions/TppCertificate" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role. Make sure you're authorized\ \ as the mandator admin client." schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "Certificate is invalid or expired" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4696,27 +4741,27 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Requested certificate" schema: $ref: "#/definitions/TppCertificate" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Certificate not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4741,21 +4786,21 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Certificate deleted (empty response body)" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Certificate not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4793,42 +4838,43 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" responses: - 200: + "200": description: "Requested TPP credentials" schema: $ref: "#/definitions/PageableTppCredentialResources" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role. Make sure you're authorized\ \ as the mandator admin client." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4854,29 +4900,29 @@ paths: $ref: "#/definitions/TppCredentialsParams" x-exportParamName: "Body" responses: - 200: + "200": description: "An identifier of the stored tpp client credential" schema: $ref: "#/definitions/TppCredentials" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role. Make sure you're authorized\ \ as the mandator admin client." schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "UNKNOWN_ENTITY if the specified TPP authentication group does\ \ not exist;
ILLEGAL_FIELD_VALUE if the given validity dates are invalid" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4898,6 +4944,19 @@ paths: \ functions as a 'get all' service." operationId: "getAndSearchTppAuthenticationGroups" parameters: + - name: "ids" + in: "query" + description: "A comma-separated list of TPP authentication group identifiers.\ + \ If specified, then only TPP authentication groups whose identifier match\ + \ any of the given identifiers will be regarded. The maximum number of identifiers\ + \ is 1000." + required: false + type: "array" + items: + type: "integer" + format: "int64" + collectionFormat: "multi" + x-exportParamName: "Ids" - name: "name" in: "query" description: "Only the tpp authentication groups with name matching the given\ @@ -4928,42 +4987,43 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" responses: - 200: + "200": description: "Requested TPP authentication groups" schema: $ref: "#/definitions/PageableTppAuthenticationGroupResources" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role. Make sure you're authorized\ \ as the mandator admin client." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -4990,27 +5050,27 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Requested TPP credentials" schema: $ref: "#/definitions/TppCredentials" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "TPP credentials not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -5036,21 +5096,21 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "TPP credentials deleted (empty response body)" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "TPP credentials not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -5082,32 +5142,32 @@ paths: $ref: "#/definitions/EditTppCredentialParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Edited TPP credentials" schema: $ref: "#/definitions/TppCredentials" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "TPP credentials not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "UNKNOWN_ENTITY if the specified TPP authentication group does\ \ not exist;
ILLEGAL_FIELD_VALUE if the given validity dates are invalid" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -5381,21 +5441,22 @@ paths: required: false type: "integer" default: 1 - minimum: 1.0 + minimum: 1 x-exportParamName: "Page" x-optionalDataType: "Int32" - name: "perPage" in: "query" - description: "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." + description: "Maximum number of records per page. By default it's 20. 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." required: false type: "integer" default: 20 - maximum: 500.0 - minimum: 1.0 + maximum: 500 + minimum: 1 x-exportParamName: "PerPage" x-optionalDataType: "Int32" - name: "order" @@ -5422,23 +5483,23 @@ paths: collectionFormat: "multi" x-exportParamName: "Order" responses: - 200: + "200": description: "List of requested transactions" schema: $ref: "#/definitions/PageableTransactionList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -5463,8 +5524,8 @@ paths: \ If not specified, then no date limitation will be in place for the deletion." required: false type: "string" - maximum: 10.0 - minimum: 10.0 + maximum: 10 + minimum: 10 x-exportParamName: "MaxDeletionDate" x-optionalDataType: "String" - name: "safeMode" @@ -5499,23 +5560,23 @@ paths: x-exportParamName: "RememberDeletion" x-optionalDataType: "Bool" responses: - 200: + "200": description: "List of identifiers of all deleted transactions" schema: $ref: "#/definitions/IdentifierList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -5547,32 +5608,32 @@ paths: $ref: "#/definitions/UpdateMultipleTransactionsParams" x-exportParamName: "Body" responses: - 200: + "200": description: "List of identifiers of all updated transactions" schema: $ref: "#/definitions/IdentifierList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Category or labels not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "If 'isPotentialDuplicate' is set to 'true' (only 'false' is\ \ allowed)" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -5617,30 +5678,30 @@ paths: $ref: "#/definitions/TriggerCategorizationParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Categorizations have been scheduled (empty response body)" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Given bank connection(s) not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "At least one of the target bank connections is currently locked,\ \ or there are no bank connections to trigger categorization for" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -5677,23 +5738,23 @@ paths: pattern: "[\\d]+,[\\d,]+" x-exportParamName: "Ids" responses: - 200: + "200": description: "List of requested transactions" schema: $ref: "#/definitions/TransactionList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -5739,32 +5800,32 @@ paths: $ref: "#/definitions/UpdateTransactionsParams" x-exportParamName: "Body" responses: - 200: + "200": description: "List of identifiers of all edited transactions" schema: $ref: "#/definitions/IdentifierList" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Category or labels not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "If 'isPotentialDuplicate' is set to 'true' (only 'false' is\ \ allowed)" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -5792,27 +5853,27 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Requested transaction" schema: $ref: "#/definitions/Transaction" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Transaction not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -5844,29 +5905,29 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Transaction deleted (empty response body)" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Transaction not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "Transaction cannot get deleted" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -5903,32 +5964,32 @@ paths: $ref: "#/definitions/UpdateTransactionsParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Edited transaction" schema: $ref: "#/definitions/Transaction" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Transaction, category or labels not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "If 'isPotentialDuplicate' is set to 'true' (only 'false' is\ \ allowed)" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -5954,32 +6015,32 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Restored transaction" schema: $ref: "#/definitions/Transaction" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Transaction not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "The request transaction is a sub-transaction and can not be\ \ restored." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6014,34 +6075,34 @@ paths: $ref: "#/definitions/SplitTransactionsParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Split transaction" schema: $ref: "#/definitions/Transaction" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Transaction, category or labels not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "ILLEGAL_ENTITY_STATE if the transaction you are trying to\ \ split is a sub-transaction; ILLEGAL_FIELD_VALUE if there is less than\ \ two sub-transactions specified, or the specified sub-transactions' amounts\ \ do not add up to the original transaction's amount" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6061,19 +6122,19 @@ paths: operationId: "getAuthorizedUser" parameters: [] responses: - 200: + "200": description: "Authorized user's data" schema: $ref: "#/definitions/User" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6106,29 +6167,29 @@ paths: $ref: "#/definitions/UserCreateParams" x-exportParamName: "Body" responses: - 201: + "201": description: "Created user's data" schema: $ref: "#/definitions/User" - 400: + "400": description: "Bad request (for instance if the given password is too short/long)" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "ENTITY_EXISTS if the given userId already exists; ILLEGAL_ENTITY_STATE\ \ if you passed 'isAutoUpdateEnabled' = true, but the automatic update\ \ can't be enabled for this user (as it is disabled for the client)." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6153,24 +6214,24 @@ paths: operationId: "deleteAuthorizedUser" parameters: [] responses: - 200: + "200": description: "User deleted (empty response body)" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "User cannot get deleted at the moment as at least one of his\ \ bank connections is currently being imported or updated (either by the\ \ user or by finAPI's automatic batch update), or because the categorization\ \ of transactions is performed." schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6197,27 +6258,27 @@ paths: $ref: "#/definitions/UserUpdateParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Edited user data" schema: $ref: "#/definitions/User" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "The automatic update cannot be enabled" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6244,26 +6305,26 @@ paths: $ref: "#/definitions/ExecutePasswordChangeParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Password changed (empty response body)" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role, or the given password change\ \ token is not valid" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "User not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6288,31 +6349,31 @@ paths: $ref: "#/definitions/RequestPasswordChangeParams" x-exportParamName: "Body" responses: - 200: + "200": description: "Details of change password request" schema: $ref: "#/definitions/PasswordChangingResource" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "User not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "User is not verified" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6338,23 +6399,23 @@ paths: type: "string" x-exportParamName: "UserId" responses: - 200: + "200": description: "User's verification status" schema: $ref: "#/definitions/VerificationStatusResource" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "User not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6381,29 +6442,29 @@ paths: type: "string" x-exportParamName: "UserId" responses: - 200: + "200": description: "User verified (empty response body)" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "User not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "User already verified" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6433,29 +6494,29 @@ paths: type: "string" x-exportParamName: "UserId" responses: - 200: + "200": description: "User deleted (empty response body)" - 400: + "400": description: "Identifier is not given" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "User not found" schema: $ref: "#/definitions/ErrorMessage" - 422: + "422": description: "The user with the given identifier is already verified" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6484,27 +6545,27 @@ paths: format: "int64" x-exportParamName: "Id" responses: - 200: + "200": description: "Requested web form" schema: $ref: "#/definitions/WebForm" - 400: + "400": description: "Bad request" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Not authenticated or invalid access_token" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 404: + "404": description: "Web Form not found" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6555,19 +6616,19 @@ paths: x-exportParamName: "TokenTypeHint" x-optionalDataType: "String" responses: - 200: + "200": description: "Token was invalidated successfully or token was invalid (empty\ \ response body)" - 400: + "400": description: "The service does not support the revocation of the presented\ \ token type." schema: $ref: "#/definitions/ErrorMessage" - 403: + "403": description: "Incorrect authorization role" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6687,28 +6748,28 @@ paths: x-exportParamName: "Password" x-optionalDataType: "String" responses: - 200: + "200": description: "Requested token" schema: $ref: "#/definitions/AccessToken" - 400: + "400": description: "Bad user credentials, or invalid refresh_token, or unsupported\ \ grant_type" schema: $ref: "#/definitions/ErrorMessage" - 401: + "401": description: "Bad client credentials" schema: $ref: "#/definitions/BadCredentialsError" - 403: + "403": description: "User is not verified" schema: $ref: "#/definitions/ErrorMessage" - 423: + "423": description: "User is locked" schema: $ref: "#/definitions/ErrorMessage" - 500: + "500": description: "An unexpected error occurred" schema: $ref: "#/definitions/ErrorMessage" @@ -6744,10 +6805,6 @@ definitions: example: "0b9KjiBVlZLz7a4HshSAIcFuscStiXT1VzT5mgNYwCQ_dWctTDsaIjedAhD1LpsOFJ7x6K8Emf8M3VOQkwNFR9FHijALYSQw2UeRwAC2MvrOKwfF1dHmOq5VEVYEaGf6" description: "Refresh token. Only set in case of grant_type='password'. Token\ \ has a length of up to 128 characters." - access_token: - type: "string" - example: "yvMbx_TgwdYE0hgOVb8N4ZOvxOukqfjzYOGRZcJiCjQuRGkVIBfjjV3YG4zKTGiY2aPn2cQTGaQOT8uo5uo7_QOXts1s5UBSVuRHc6a8X30RrGBTyqV9h26SUHcZPNbZ" - description: "Access token. Token has a length of up to 128 characters." expires_in: type: "integer" format: "int32" @@ -6755,6 +6812,10 @@ definitions: description: "Expiration time in seconds. A value of 0 means that the token\ \ never expires (unless it is explicitly invalidated, e.g. by revocation,\ \ or when a user gets locked)." + access_token: + type: "string" + example: "yvMbx_TgwdYE0hgOVb8N4ZOvxOukqfjzYOGRZcJiCjQuRGkVIBfjjV3YG4zKTGiY2aPn2cQTGaQOT8uo5uo7_QOXts1s5UBSVuRHc6a8X30RrGBTyqV9h26SUHcZPNbZ" + description: "Access token. Token has a length of up to 128 characters." description: "User access token info" example: access_token: "yvMbx_TgwdYE0hgOVb8N4ZOvxOukqfjzYOGRZcJiCjQuRGkVIBfjjV3YG4zKTGiY2aPn2cQTGaQOT8uo5uo7_QOXts1s5UBSVuRHc6a8X30RrGBTyqV9h26SUHcZPNbZ" @@ -7330,8 +7391,8 @@ definitions: \ set via PATCH),
7 = Membership,
8 = Bausparen


Note:\ \ this field is deprecated and will be removed at some point. Please refer\ \ to the accountType field instead." - minimum: 1.0 - maximum: 7.0 + minimum: 1 + maximum: 7 accountType: type: "string" example: "Checking" @@ -7455,10 +7516,9 @@ definitions: isSupported: type: "boolean" example: true - description: "Whether this bank is supported by finAPI, i.e. whether you can\ - \ import/update a bank connection of this bank.

NOTE: This field\ - \ is deprecated and will be removed at some point. Please refer to field\ - \ 'interfaces' instead." + description: "THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Please refer to\ + \ field 'interfaces' instead.

Whether this bank is supported by\ + \ finAPI, i.e. whether you can import/update a bank connection of this bank." isTestBank: type: "boolean" example: true @@ -7482,15 +7542,16 @@ definitions: type: "integer" format: "int32" example: 100 - description: "The health status of this bank. This is a value between 0 and\ - \ 100, depicting the percentage of successful communication attempts with\ - \ this bank during the latest couple of bank connection imports or updates\ - \ (across the entire finAPI system). Note that 'successful' 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." - minimum: 0.0 - maximum: 100.0 + description: "THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'health'\ + \ in the 'interfaces' instead.

The health status of this bank.\ + \ This is a value between 0 and 100, depicting the percentage of successful\ + \ communication attempts with this bank during the latest couple of bank\ + \ connection imports or updates (across the entire finAPI system). Note\ + \ that 'successful' 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." + minimum: 0 + maximum: 100 loginFieldUserId: type: "string" example: "Onlinebanking-ID" @@ -7574,22 +7635,27 @@ definitions: lastCommunicationAttempt: type: "string" example: "2018-01-01 00:00:00.000" - description: "Time of the last communication attempt with this bank during\ - \ a bank connection import or update (across the entire finAPI system).\ - \ The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german\ - \ time)." + description: "THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'lastCommunicationAttempt'\ + \ in the 'interfaces' instead.

Time of the last communication\ + \ attempt with this bank during a bank connection import or update (across\ + \ the entire finAPI system). The value is returned in the format 'YYYY-MM-DD\ + \ HH:MM:SS.SSS' (german time)." lastSuccessfulCommunication: type: "string" example: "2018-01-01 00:00:00.000" - description: "Time of the last successful communication with this bank during\ - \ a bank connection import or update (across the entire finAPI system).\ - \ The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german\ - \ time)." + description: "THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'lastSuccessfulCommunication'\ + \ in the 'interfaces' instead.

Time of the last successful communication\ + \ with this bank during a bank connection import or update (across the entire\ + \ finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS'\ + \ (german time)." description: "Container for a bank's data" example: lastCommunicationAttempt: "2018-01-01 00:00:00.000" interfaces: - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -7604,6 +7670,9 @@ definitions: properties: - "REDIRECT_APPROACH" - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -7772,14 +7841,12 @@ definitions: description: "NOTE: This field is deprecated and will be removed at some point.\ \ Please refer to corresponding field in 'interfaces' instead.

The\ \ default two-step-procedure. Must match one of the available 'procedureId's\ - \ from the 'twoStepProcedures' list. When this field is set, you can execute\ - \ two-step-procedures (accounts/requestSepaMoneyTransfer or /requestSepaDirectDebit)\ - \ without having to explicitly set a procedure. finAPI will use the default\ - \ procedure in such cases. Note that the list of available procedures of\ - \ a bank connection may change as a result of an update of the connection,\ - \ and if this field references a procedure that is no longer available after\ - \ an update, finAPI will automatically clear the default procedure (set\ - \ it to null).s" + \ from the 'twoStepProcedures' list. When this field is set, then finAPI\ + \ will automatically try to select the procedure wherever applicable. Note\ + \ that the list of available procedures of a bank connection may change\ + \ as a result of an update of the connection, and if this field references\ + \ a procedure that is no longer available after an update, finAPI will automatically\ + \ clear the default procedure (set it to null)." twoStepProcedures: type: "array" description: "NOTE: This field is deprecated and will be removed at some point.\ @@ -7819,16 +7886,18 @@ definitions: type: "boolean" example: true description: "This field indicates whether the last communication with the\ - \ bank failed with an error that requires the user's attention. If 'furtherLoginNotRecommended'\ - \ is true, finAPI will stop auto updates of this bank connection to mitigate\ - \ the risk of the user's bank account getting locked by the bank. Every\ - \ communication with the bank (via updates, money_transfers, direct debits.\ - \ etc.) can change the value of this flag. If this field is true, we recommend\ - \ the user to check his credentials and try a manual update of the bank\ - \ connection. If the update is successful, the 'furtherLoginNotRecommended'\ - \ field will be set to false and the bank connection will be reincluded\ - \ in the next batch update process. A manual update of the bank connection\ - \ with incorrect credentials will set this field to true and lead to the\ + \ bank failed with an error that requires the user's attention or multi-step\ + \ authentication error. If 'furtherLoginNotRecommended' is true, finAPI\ + \ will stop auto updates of this bank connection to mitigate the risk of\ + \ the user's bank account getting locked by the bank. Every communication\ + \ with the bank (via updates, money_transfers, direct debits. etc.) can\ + \ change the value of this flag. If this field is true, we recommend the\ + \ user to check his credentials and try a manual update of the bank connection.\ + \ If the update is successful without any multi-step authentication error,\ + \ the 'furtherLoginNotRecommended' field will be set to false and the bank\ + \ connection will be reincluded in the next batch update process. A manual\ + \ update of the bank connection with incorrect credentials or if multi-step\ + \ authentication error happens will set this field to true and lead to the\ \ exclusion of the bank connection from the following batch updates." description: "Container for a bank connection's data" example: @@ -7932,6 +8001,9 @@ definitions: lastCommunicationAttempt: "2018-01-01 00:00:00.000" interfaces: - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -7946,6 +8018,9 @@ definitions: properties: - "REDIRECT_APPROACH" - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -8209,6 +8284,9 @@ definitions: lastCommunicationAttempt: "2018-01-01 00:00:00.000" interfaces: - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -8223,6 +8301,9 @@ definitions: properties: - "REDIRECT_APPROACH" - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -8380,6 +8461,9 @@ definitions: lastCommunicationAttempt: "2018-01-01 00:00:00.000" interfaces: - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -8394,6 +8478,9 @@ definitions: properties: - "REDIRECT_APPROACH" - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -8542,6 +8629,7 @@ definitions: BankInterface: type: "object" required: + - "health" - "interface" - "loginCredentials" properties: @@ -8573,7 +8661,12 @@ definitions: description: "Set of interface properties/specifics. Possible values:

•\ \ REDIRECT_APPROACH - 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.

• DECOUPLED_APPROACH\ + \ 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:
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>?\n
• DECOUPLED_APPROACH\ \ - means that the interface uses a decoupled approach when authorizing\ \ the user.

• DETAILED_CONSENT - means that the\ \ interface requires a list of account references when authorizing the user.\ @@ -8598,9 +8691,39 @@ definitions: \ 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." + health: + type: "integer" + format: "int32" + example: 100 + description: "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 latest couple of bank connection\ + \ imports or updates (across the entire finAPI system). Note that 'successful'\ + \ 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." + minimum: 0 + maximum: 100 + lastCommunicationAttempt: + type: "string" + example: "2018-01-01 00:00:00.000" + description: "Time of the last communication attempt with this interface during\ + \ an import, update or connect interface (across the entire finAPI system).\ + \ The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german\ + \ time)." + lastSuccessfulCommunication: + type: "string" + example: "2018-01-01 00:00:00.000" + description: "Time of the last successful communication with this interface\ + \ during an import, update or connect interface (across the entire finAPI\ + \ system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS'\ + \ (german time)." description: "Interface used to connect to a bank" example: loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -8663,6 +8786,9 @@ definitions: - lastCommunicationAttempt: "2018-01-01 00:00:00.000" interfaces: - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -8677,6 +8803,9 @@ definitions: properties: - "REDIRECT_APPROACH" - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -8714,6 +8843,9 @@ definitions: - lastCommunicationAttempt: "2018-01-01 00:00:00.000" interfaces: - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -8728,6 +8860,9 @@ definitions: properties: - "REDIRECT_APPROACH" - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -9109,8 +9244,8 @@ definitions: \ = CreditCard,
4 = Security,
5 = Loan,
6 = Pocket (DEPRECATED;\ \ will not be returned for any account unless this type has explicitly been\ \ set via PATCH),
7 = Membership,
8 = Bausparen

" - minimum: 1.0 - maximum: 7.0 + minimum: 1 + maximum: 7 amount: type: "number" example: -99.99 @@ -9306,7 +9441,8 @@ definitions: isXs2aEnabled: type: "boolean" example: true - description: "Whether this client is allowed to access XS2A services." + description: "NOTE: This field is deprecated and will be removed at some point.

Whether\ + \ this client is allowed to access XS2A services." availableBankGroups: type: "array" example: @@ -9345,6 +9481,14 @@ definitions: \ user allowing him to choose whether to store login secrets (like a PIN)\ \ in finAPI. If this field is set to false, then the user won't have an\ \ option to store this data." + supportSubjectDefault: + type: "string" + example: "Some subject" + description: "Default value for the subject element of support emails." + supportEmail: + type: "string" + example: "email@localhost.de" + description: "Email address to sent support requests to from the web form." pinStorageAvailableInWebForm: type: "boolean" example: true @@ -9374,6 +9518,8 @@ definitions: - "DE" - "AT" - "IT" + supportSubjectDefault: "Some subject" + supportEmail: "email@localhost.de" userNotificationCallbackUrl: "https://bank.server.com/notification" isXs2aEnabled: true isAutomaticBatchUpdateEnabled: true @@ -9490,6 +9636,19 @@ definitions: \ Only hexa decimal characters in capital case with a maximum length of\ \ 25 characters are allowed. E.g. 'ABCDEF1234567890ABCDEF123'" pattern: "[0-9A-F]*" + supportSubjectDefault: + type: "string" + example: "Some subject" + description: "Default value for the subject element of support emails. Maximum\ + \ length is 100. Pass an empty string ('') if you want to clear the current\ + \ subject default value." + supportEmail: + type: "string" + example: "email@localhost.de" + description: "Email address to sent support requests to from the web form.\ + \ Maximum length is 320. Pass an empty string ('') if you want to clear\ + \ the current email address." + pattern: "[A-Za-z0-9¡-ʯ &\\(\\)\\{\\}\\[\\]\\.:,;\\?!\\+\\-_\\$@#~`\\^€]*" description: "Client configuration parameters" ConnectInterfaceParams: type: "object" @@ -9776,6 +9935,7 @@ definitions: \ do not want to change the current name let this field remain unset. If\ \ you want to clear the current name, set the field's value to an empty\ \ string (\"\")." + pattern: "[A-Za-z0-9¡-ʯ &\\(\\)\\{\\}\\[\\]\\.:,;\\?!\\+\\-_\\$@#~`\\^€]*" bankingUserId: type: "string" example: "123456" @@ -9788,7 +9948,7 @@ definitions: \ the service recognizes that you wish to use the web form flow. Note that\ \ you cannot clear the current user ID, i.e. a bank connection must always\ \ have a user ID (except for when it is a 'demo connection'). Max length:\ - \ 64." + \ 170." bankingCustomerId: type: "string" example: "123456" @@ -9800,7 +9960,7 @@ definitions: \ to let the user update the field, just set the field to non-empty value,\ \ so that the service recognizes that you wish to use the web form flow.\ \ If you want to clear the current customer ID, set the field's value to\ - \ an empty string (\"\"). Max length: 64." + \ an empty string (\"\"). Max length: 170." bankingPin: type: "string" example: "123456" @@ -9947,8 +10107,10 @@ definitions: type: type: "string" example: "TECHNICAL" - description: "Error type. BUSINESS errors depict German error messages for\ - \ the user, e.g. from a bank server. TECHNICAL errors depict internal errors." + description: "Error type. BUSINESS errors depict error messages in the language\ + \ of the bank (or the preferred language) for the user, e.g. from a bank\ + \ server. TECHNICAL errors are meant to be read by developers and depict\ + \ internal errors." enum: - "BUSINESS" - "TECHNICAL" @@ -10013,7 +10175,7 @@ definitions: type: "string" example: "password" description: "User's new password. Minimum length is 6, and maximum length\ - \ is 36." + \ is 128." pattern: "[A-Za-z0-9¡-ʯ &\\(\\)\\{\\}\\[\\]\\.:,;\\?!\\+\\-_\\$@#~`\\^€]*" passwordChangeToken: type: "string" @@ -10116,6 +10278,22 @@ definitions: parentId: 373 creationDate: "2018-01-01 00:00:00.000" direction: "Income" + IbanRuleIdentifiersParams: + type: "object" + required: + - "ids" + properties: + ids: + type: "array" + example: + - 1 + - 2 + - 3 + description: "List of identifiers" + items: + type: "integer" + format: "int64" + description: "Identifiers params" IbanRuleList: type: "object" required: @@ -10164,6 +10342,10 @@ definitions: - "direction" - "iban" properties: + iban: + type: "string" + example: "DE89370400440532013000" + description: "IBAN (case-insensitive)" categoryId: type: "integer" format: "int64" @@ -10183,10 +10365,6 @@ definitions: - "Income" - "Spending" - "Both" - iban: - type: "string" - example: "DE89370400440532013000" - description: "IBAN (case-insensitive)" description: "Parameters of IBAN rule" IbanRulesParams: type: "object" @@ -10222,22 +10400,6 @@ definitions: - 1 - 2 - 3 - IdentifiersParams: - type: "object" - required: - - "ids" - properties: - ids: - type: "array" - example: - - 1 - - 2 - - 3 - description: "List of identifiers" - items: - type: "integer" - format: "int64" - description: "Identifiers params" ImportBankConnectionParams: type: "object" required: @@ -10259,7 +10421,7 @@ definitions: description: "NOTE: This field is deprecated and will be removed at some point.\ \ Use 'loginCredentials' + 'interface' instead. If any of those two fields\ \ is used, then the value of this field will be ignored.

Online banking\ - \ user ID credential. Max length: 64. NOTES:
- if you import the 'demo\ + \ user ID credential. Max length: 170. NOTES:
- if you import the 'demo\ \ connection', this field can be left unset;
- if the user will need\ \ to enter his credentials in finAPI's web form, this field can contain\ \ any value. It will be ignored." @@ -10270,7 +10432,7 @@ definitions: \ Use 'loginCredentials' + 'interface' instead. If any of those two fields\ \ is used, then the value of this field will be ignored.

Online banking\ \ customer ID credential (for most banks this field can remain unset). Max\ - \ length: 64. NOTES:
- if the user will need to enter his credentials\ + \ length: 170. NOTES:
- if the user will need to enter his credentials\ \ in finAPI's web form, this field can contain any value. It will be ignored." bankingPin: type: "string" @@ -10374,8 +10536,10 @@ definitions: \ download transactions for the entire given date range, as the bank servers\ \ may limit the date range on their own. Also note that this parameter only\ \ applies to transactions, not to security positions; finAPI will always\ - \ download all positions that it can get.

This flag is currently\ - \ not guaranteed to work for all banks!" + \ download all positions that it can get.

Please note: If you\ + \ are not limiting the maxDaysForDownload with a value smaller than 90 days,\ + \ the bank is more likely to trigger a strong customer authentication request\ + \ for the user." default: 0 accountTypes: type: "array" @@ -10525,6 +10689,22 @@ definitions: parentId: 373 creationDate: "2018-01-01 00:00:00.000" direction: "Spending" + KeywordRuleIdentifiersParams: + type: "object" + required: + - "ids" + properties: + ids: + type: "array" + example: + - 1 + - 2 + - 3 + description: "List of identifiers" + items: + type: "integer" + format: "int64" + description: "Identifiers params" KeywordRuleList: type: "object" required: @@ -10698,7 +10878,11 @@ definitions: \ the user." value: type: "string" - description: "Stored value for this login credential" + description: "Stored value for this login credential. Please NOTE:
•\ + \ If a PIN is stored, this will always be 'XXXXX'.
• If your client\ + \ has no license for processing banking credentials or if this field contains\ + \ a value that requires password protection then this field will always\ + \ be 'XXXXX'." description: "Container for a bank login credential" example: label: "Customer ID" @@ -10965,14 +11149,27 @@ definitions: type: "string" example: "CHALLENGE_RESPONSE_REQUIRED" description: "Indicates the current status of the multi-step authentication\ - \ flow:
• CHALLENGE_RESPONSE_REQUIRED - means that the bank has\ - \ sent a 'challengeMessage' which must be presented to the user. The user's\ - \ answer must then be passed back to finAPI as 'challengeResponse';
•\ - \ TWO_STEP_PROCEDURE_REQUIRED - means that the user has to select one of\ - \ the 'twoStepProcedures'. The selection must then be passed back to finAPI\ - \ as 'twoStepProcedureId';
• REDIRECT_REQUIRED - means that the\ - \ bank has sent a 'redirectUrl', to which the user must be forwarded. The\ - \ bank's callback must then be passed back to finAPI as 'redirectCallback'." + \ flow:

TWO_STEP_PROCEDURE_REQUIRED means that the bank has requested\ + \ an SCA method selection for the user. In this case, the service should\ + \ be recalled with a chosen TSP-ID set to the 'twoStepProcedureId' field.
When\ + \ the web form flow is used, the user is forwarded to finAPI's web form\ + \ to prompt for his credentials (if they are not stored in finAPI) and to\ + \ select the preferred SCA method.

CHALLENGE_RESPONSE_REQUIRED\ + \ means that the bank has requested a challenge code for the previously\ + \ given TSP (SCA). This status can be completed by setting the 'challengeResponse'\ + \ field.
When the web form flow is used, the user should submit the\ + \ challenge response for the challenge message shown by the web form.

REDIRECT_REQUIRED\ + \ means that the user must be redirected to the bank's website, where the\ + \ authentication can be finished.
When the web form flow is used, the\ + \ user should visit the web form, get a redirect to the bank's website,\ + \ complete the authentication and will then be redirected back to the web\ + \ form.

DECOUPLED_AUTH_REQUIRED means that the bank has asked for\ + \ the decoupled authentication. In this case, the 'decoupledCallback' field\ + \ must be set to true to complete the authentication.

DECOUPLED_AUTH_IN_PROGRESS\ + \ means that the bank is waiting for the completion of the decoupled authentication\ + \ by the user. Until this is done, the service should be recalled with the\ + \ 'decoupledCallback' field set to ‘true’. Once the decoupled authentication\ + \ is completed by the user, the service returns a successful response." enum: - "CHALLENGE_RESPONSE_REQUIRED" - "TWO_STEP_PROCEDURE_REQUIRED" @@ -11234,6 +11431,9 @@ definitions: - lastCommunicationAttempt: "2018-01-01 00:00:00.000" interfaces: - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -11248,6 +11448,9 @@ definitions: properties: - "REDIRECT_APPROACH" - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -11285,6 +11488,9 @@ definitions: - lastCommunicationAttempt: "2018-01-01 00:00:00.000" interfaces: - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -11299,6 +11505,9 @@ definitions: properties: - "REDIRECT_APPROACH" - loginHint: "Bitte geben Sie nur die ersten fünf Stellen Ihrer PIN ein." + lastCommunicationAttempt: "2018-01-01 00:00:00.000" + lastSuccessfulCommunication: "2018-01-01 00:00:00.000" + health: 100 interface: "FINTS_SERVER" tppAuthenticationGroup: name: "AirBank XS2A CZ" @@ -12278,16 +12487,22 @@ definitions: description: "BIC of the recipient's account. Note: This field is optional\ \ when you pass a clearing account as the recipient or if the bank connection\ \ of the account that you want to transfer money from supports the IBAN-Only\ - \ money transfer. You can find this out via GET /bankConnections/. Also\ - \ note that when a BIC is given, then this BIC will be used for the money\ - \ transfer request independent of whether it is required or not (unless\ - \ you pass a clearing account, in which case this field will always be ignored)." + \ money transfer. You can find this out via GET /bankConnections/. If\ + \ no BIC is given, finAPI will try to recognize it using the given recipientIban\ + \ value (if it's given). And then if the result value is not empty, it will\ + \ be used for the money transfer request independent of whether it is required\ + \ or not (unless you pass a clearing account, in which case the value will\ + \ always be ignored)." clearingAccountId: type: "string" example: "BA-TUYEF7D24CGK6" description: "Identifier of a clearing account. If this field is set, then\ \ the fields 'recipientName', 'recipientIban' and 'recipientBic' will be\ \ ignored and the recipient account will be the specified clearing account." + endToEndId: + type: "string" + example: "001100550526" + description: "End-To-End ID for the transfer transaction" amount: type: "number" example: 99.99 @@ -12575,9 +12790,10 @@ definitions: description: "BIC of the debitor's account. Note: This field is optional if\ \ - and only if - the bank connection of the account that you want to transfer\ \ money to supports the IBAN-Only direct debit. You can find this out via\ - \ GET /bankConnections/. Also note that when a BIC is given, then this\ - \ BIC will be used for the direct debit request independent of whether it\ - \ is required or not." + \ GET /bankConnections/. If no BIC is given, finAPI will try to recognize\ + \ it using the given debitorIban value (if it's given). And then if the\ + \ result value is not empty, it will be used for the direct debit request\ + \ independent of whether it is required or not." amount: type: "number" example: 99.99 @@ -12635,16 +12851,22 @@ definitions: description: "BIC of the recipient's account. Note: This field is optional\ \ when you pass a clearing account as the recipient or if the bank connection\ \ of the account that you want to transfer money from supports the IBAN-Only\ - \ money transfer. You can find this out via GET /bankConnections/. Also\ - \ note that when a BIC is given, then this BIC will be used for the money\ - \ transfer request independent of whether it is required or not (unless\ - \ you pass a clearing account, in which case this field will always be ignored)." + \ money transfer. You can find this out via GET /bankConnections/. If\ + \ no BIC is given, finAPI will try to recognize it using the given recipientIban\ + \ value (if it's given). And then if the result value is not empty, it will\ + \ be used for the money transfer request independent of whether it is required\ + \ or not (unless you pass a clearing account, in which case the value will\ + \ always be ignored)." clearingAccountId: type: "string" example: "BA-TUYEF7D24CGK6" description: "Identifier of a clearing account. If this field is set, then\ \ the fields 'recipientName', 'recipientIban' and 'recipientBic' will be\ \ ignored and the recipient account will be the specified clearing account." + endToEndId: + type: "string" + example: "001100550526" + description: "End-To-End ID for the transfer transaction" amount: type: "number" example: 99.99 @@ -12808,17 +13030,18 @@ definitions: description: "A certificate (public key)" privateKey: type: "string" - description: "A private key in PKCS #8 format. PKCS #8 private keys are typically\ - \ exchanged in the PEM base64-encoded format (https://support.quovadisglobal.com/kb/a37/what-is-pem-format.aspx)

NOTE:\ + description: "A private key in PKCS #8 or PKCS #1 format. PKCS #1/#8 private\ + \ keys are typically exchanged in the PEM base64-encoded format (https://support.quovadisglobal.com/kb/a37/what-is-pem-format.aspx)

NOTE:\ \ The certificate should have one of the following headers:
- '-----BEGIN\ - \ PRIVATE KEY-----'
- '-----BEGIN ENCRYPTED PRIVATE KEY-----'
Any\ - \ other header denotes that the private key is NOT in PKCS #8 format!" + \ RSA PRIVATE KEY-----'
- '-----BEGIN PRIVATE KEY-----'
- '-----BEGIN\ + \ ENCRYPTED PRIVATE KEY-----'
Any other header denotes that the private\ + \ key is neither in PKCS #8 nor in PKCS #1 formats!" passphrase: type: "string" description: "Optional passphrase for the private key" label: type: "string" - description: "Optional label to certificate to identify in the list of certificates" + description: "A label for certificate to identify in the list of certificates" validFromDate: type: "string" example: "2019-04-23" @@ -12869,8 +13092,6 @@ definitions: required: - "label" - "tppAuthenticationGroupId" - - "tppClientId" - - "tppClientSecret" properties: tppAuthenticationGroupId: type: "integer" @@ -12936,8 +13157,8 @@ definitions: \ = CreditCard,
4 = Security,
5 = Loan,
6 = Pocket (DEPRECATED;\ \ will not be returned for any account unless this type has explicitly been\ \ set via PATCH),
7 = Membership,
8 = Bausparen

" - minimum: 1.0 - maximum: 7.0 + minimum: 1 + maximum: 7 amount: type: "number" example: -99.99 @@ -13853,7 +14074,7 @@ definitions: type: "string" example: "password" description: "User's password. Minimum length is 6, and maximum length is\ - \ 36. If not specified, then a unique random value will be generated." + \ 128. If not specified, then a unique random value will be generated." pattern: "[A-Za-z0-9¡-ʯ &\\(\\)\\{\\}\\[\\]\\.:,;\\?!\\+\\-_\\$@#~`\\^€]*" email: type: "string" diff --git a/api_accounts.go b/api_accounts.go index 2fd93a9..218714f 100644 --- a/api_accounts.go +++ b/api_accounts.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -1113,7 +1113,7 @@ Returns the user's daily balances for a given period and a set of specified * @param "EndDate" (optional.String) - 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. * @param "WithProjection" (optional.Bool) - Whether finAPI should project the first and last actually existing balance of an account 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 regarded accounts, and only up to the day where the last actual balance exists for any of the regarded 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'. * @param "Page" (optional.Int32) - Result page that you want to retrieve. - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. * @param "Order" (optional.Interface of []string) - 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). @return DailyBalanceList diff --git a/api_authorization.go b/api_authorization.go index 3b368e7..6fa7419 100644 --- a/api_authorization.go +++ b/api_authorization.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/api_bank_connections.go b/api_bank_connections.go index 86f615a..922fdbc 100644 --- a/api_bank_connections.go +++ b/api_bank_connections.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -1051,7 +1051,7 @@ func (a *BankConnectionsApiService) GetMultipleBankConnections(ctx context.Conte /* BankConnectionsApiService Import a new bank connection -Imports a new bank connection for a specific user. Must pass the connection credentials and the user's access_token. All bank accounts will be downloaded and imported with their current balances, transactions and supported two-step-procedures (note that the amount of available transactions may vary between banks, e.g. some banks deliver all transactions from the past year, others only deliver the transactions from the past three months). The balance and transactions download process runs asynchronously, so this service may return before all balances and transactions have been imported. Also, all downloaded transactions will be categorized by a separate background process that runs asynchronously too. To check the status of the balance and transactions download process as well as the background categorization process, see the status flags that are returned by the GET /bankConnections/<id> service.<br/><br/>You can also import a \"demo connection\" which contains a single bank account with some pre-defined transactions. To import the demo connection, you need to pass the identifier of the \"finAPI Test Bank\". In case of demo connection import, any other fields besides the bank identifier can remain unset. The bankingUserId, bankingCustomerId, bankingPin, and storeSecrets fields will be stored if you pass them, however they will not be regarded when updating the demo connection (in other words: It doesn't matter what credentials you choose for the demo connection). Note however that if you want to import the demo connection multiple times for the same user, you must use a different bankingUserId and/or bankingCustomerId for each of the imports. Also note that the skipPositionsDownload flag is ignored for the demo bank connection, i.e. when importing the demo bank connection, you will always get the transactions for its account. You can enable multi-step authentication for the demo bank connection by setting the bank connection name to \"MSA\".<br/><br/><b>For a more in-depth understanding of the import process, please also read this article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/115000296607-Import-Update-of-Bank-Connections-Accounts' target='_blank'>Import & Update of Bank Connections / Accounts</a></b><br/><br/>NOTE: Depending on your license, this service may respond with HTTP code 451, containing an error message with a identifier of web form in it. In addition to that the response will also have included a 'Location' header, which contains the URL to the web form. In this case, you must forward your user to finAPI's web form. For a detailed explanation of the Web Form Flow, please refer to this article: <a href='https://finapi.zendesk.com/hc/en-us/articles/360002596391' target='_blank'>finAPI's Web Form Flow</a><br/><br/><b>Attention:</b> Due to changes on the bank's side we have been forced to limit the maxDaysForDownload field to 89 days. Now any import or update of a bank connection will only fetch the last three months of transactions per account, regardless if maxDaysForDownload is defined or not. We're working of fixing this behaviour by implementing the multi step authentication workflow for FinTS. +Imports a new bank connection for a specific user. Must pass the connection credentials and the user's access_token. All bank accounts will be downloaded and imported with their current balances, transactions and supported two-step-procedures (note that the amount of available transactions may vary between banks, e.g. some banks deliver all transactions from the past year, others only deliver the transactions from the past three months). The balance and transactions download process runs asynchronously, so this service may return before all balances and transactions have been imported. Also, all downloaded transactions will be categorized by a separate background process that runs asynchronously too. To check the status of the balance and transactions download process as well as the background categorization process, see the status flags that are returned by the GET /bankConnections/<id> service.<br/><br/>You can also import a \"demo connection\" which contains a single bank account with some pre-defined transactions. To import the demo connection, you need to pass the identifier of the \"finAPI Test Bank\". In case of demo connection import, any other fields besides the bank identifier can remain unset. The bankingUserId, bankingCustomerId, bankingPin, and storeSecrets fields will be stored if you pass them, however they will not be regarded when updating the demo connection (in other words: It doesn't matter what credentials you choose for the demo connection). Note however that if you want to import the demo connection multiple times for the same user, you must use a different bankingUserId and/or bankingCustomerId for each of the imports. Also note that the skipPositionsDownload flag is ignored for the demo bank connection, i.e. when importing the demo bank connection, you will always get the transactions for its account. You can enable multi-step authentication for the demo bank connection by setting the bank connection name to \"MSA\".<br/><br/>The XS2A interface could also be used to initiate a demo connection import.<br/>The finAPI demo XS2A allows you to download a test account by using the 'import' or 'connectInterface' services - in general, this XS2A demo account is the FINTS_SERVER demo account, as it has the same account number and origin of balances and transactions.<br/>Keep in mind, that calling an XS2A demo connection import will result as a newly created bank connection, when the 'connectInterface' service attaches the XS2A demo account to an existing demo connection.<br/>Passing the login credentials is not obligated only for redirect banks, however the demo bank works without any given set of credentials for the XS2A interface. The old API credentials fields (bankingUserId, bankingCustomerId, bankingPin) are DEPRECATED and temporarily mapped on the new credentials data structure, allowing you to use them within the XS2A import. This is not recommended, as those fields are going to be removed at some point later.<br/>If you are looking to test the XS2A SCA (Strong Customer Authentication, or MSA (Multi-Step Authentication) in the finAPI context), you need to pass the bank connection name as \"MSA\" to trigger the SCA flow or as 'DECOUPLED-AUTH' to simulate decoupled authentication. To get better understanding about the Multi-Step Authentication, please refer to the 'Error Messages' section of the swagger documentation.<br/><br/><b>For a more in-depth understanding of the import process, please also read this article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/115000296607-Import-Update-of-Bank-Connections-Accounts' target='_blank'>Import & Update of Bank Connections / Accounts</a></b><br/><br/>NOTE: Depending on your license, this service may respond with HTTP code 451, containing an error message with a identifier of web form in it. In addition to that the response will also have included a 'Location' header, which contains the URL to the web form. In this case, you must forward your user to finAPI's web form. For a detailed explanation of the Web Form Flow, please refer to this article: <a href='https://finapi.zendesk.com/hc/en-us/articles/360002596391' target='_blank'>finAPI's Web Form Flow</a><br/><br/><b>Attention:</b> Due to changes on the bank's side we have been forced to limit the maxDaysForDownload field to 89 days to reduce the risk of strong customer authentication (SCA) requests. If you have implemented the SCA flow, please contact us, so that we can remove this limitation from your client. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param body Import bank connection parameters @@ -1354,7 +1354,7 @@ func (a *BankConnectionsApiService) RemoveInterface(ctx context.Context, body Re /* BankConnectionsApiService Update a bank connection -Update an existing bank connection of the user that is authorized by the access_token. Downloads and imports the current account balances and new transactions. Must pass the connection's identifier and the user's access_token. For more information about the processes of authentication, data download and transactions categorization, see POST /bankConnections/import. Note that supported two-step-procedures are updated as well. It may unset the current default two-step-procedure of the given bank connection (but only if this procedure is not supported anymore by the bank). You can also update the \"demo connection\" (in this case, the fields 'bankingPin', 'importNewAccounts', and 'skipPositionsDownload' will be ignored).<br/><br/>Note that you cannot trigger an update of a bank connection as long as there is still a previously triggered update running.<br/><br/><b>For a more in-depth understanding of the update process, please also read this article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/115000296607-Import-Update-of-Bank-Connections-Accounts' target='_blank'>Import & Update of Bank Connections / Accounts</a></b><br/><br/>NOTE: Depending on your license, this service may respond with HTTP code 451, containing an error message with a identifier of web form in it. In addition to that the response will also have included a 'Location' header, which contains the URL to the web form. In this case, you must forward your user to finAPI's web form. For a detailed explanation of the Web Form Flow, please refer to this article: <a href='https://finapi.zendesk.com/hc/en-us/articles/360002596391' target='_blank'>finAPI's Web Form Flow</a><br/><br/><b>Attention:</b> Due to changes on the bank's side we have been forced to limit the maxDaysForDownload field to 89 days. Now any import or update of a bank connection will only fetch the last three months of transactions per account, regardless if maxDaysForDownload is defined or not. We're working of fixing this behaviour by implementing the multi step authentication workflow for FinTS. +Update an existing bank connection of the user that is authorized by the access_token. Downloads and imports the current account balances and new transactions. Note that if the bank connection has several interfaces and some of its accounts was previously imported or updated via an interface which have higher priority than the interface used in the current update, then balances and transactions will not be downloaded for such accounts (The XS2A interface has the highest priority, followed by FINTS_SERVER and finally WEB_SCRAPER). Must pass the connection's identifier and the user's access_token. For more information about the processes of authentication, data download and transactions categorization, see POST /bankConnections/import. Note that supported two-step-procedures are updated as well. It may unset the current default two-step-procedure of the given bank connection (but only if this procedure is not supported anymore by the bank). You can also update the \"demo connection\" (in this case, the fields 'bankingPin', 'importNewAccounts', and 'skipPositionsDownload' will be ignored).<br/><br/>Note that you cannot trigger an update of a bank connection as long as there is still a previously triggered update running.<br/><br/><b>For a more in-depth understanding of the update process, please also read this article on our Dev Portal: <a href='https://finapi.zendesk.com/hc/en-us/articles/115000296607-Import-Update-of-Bank-Connections-Accounts' target='_blank'>Import & Update of Bank Connections / Accounts</a></b><br/><br/>NOTE: Depending on your license, this service may respond with HTTP code 451, containing an error message with a identifier of web form in it. In addition to that the response will also have included a 'Location' header, which contains the URL to the web form. In this case, you must forward your user to finAPI's web form. For a detailed explanation of the Web Form Flow, please refer to this article: <a href='https://finapi.zendesk.com/hc/en-us/articles/360002596391' target='_blank'>finAPI's Web Form Flow</a><br/><br/><b>Attention:</b> Due to changes on the bank's side we have been forced to limit the transaction download time frame to 89 days. Now any update of a bank connection will fetch the last three months of transactions per account. If the last successful update was more than 3 months ago, an adjusting entry ('Zwischensaldo' transaction) will be created. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param body Update bank connection parameters diff --git a/api_banks.go b/api_banks.go index 16bbd7e..a3ca15a 100644 --- a/api_banks.go +++ b/api_banks.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -44,7 +44,7 @@ Get and search banks from finAPI's database of banks. Must pass the authoriz * @param "TppAuthenticationGroupIds" (optional.Interface of []int64) - A comma-separated list of TPP authentication group identifiers. If specified, then only banks who have at least one interface belonging to one of the given groups will be regarded. The maximum number of identifiers is 1000. * @param "IsTestBank" (optional.Bool) - If specified, then only those banks will be regarded that have the given value (true or false) for their 'isTestBank' field. * @param "Page" (optional.Int32) - Result page that you want to retrieve. - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. * @param "Order" (optional.Interface of []string) - Determines the order of the results. You can order the results by 'id', 'name', 'blz', 'bic' or 'popularity'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/banks?order=name,desc&order=id,asc' will return banks ordered by 'name' (descending), where banks with the same 'name' are ordered by 'id' (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). @return PageableBankList diff --git a/api_categories.go b/api_categories.go index e8e17f4..d80ba68 100644 --- a/api_categories.go +++ b/api_categories.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -644,7 +644,7 @@ Get a list of all global finAPI categories as well as all custom categories of t * @param "Search" (optional.String) - If specified, then only those categories will be contained in the result whose 'name' contains the given search string (the matching works case-insensitive). If no categories contain the search string in their name, 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 name in order for a category to get included into the result. * @param "IsCustom" (optional.Bool) - If specified, then the result will contain only categories that are either finAPI global (in case of value 'false'), or only categories that have been created by the authorized user (in case of value 'true'). * @param "Page" (optional.Int32) - Result page that you want to retrieve. - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. * @param "Order" (optional.Interface of []string) - Determines the order of the results. You can order the results by 'id', 'name' and 'isCustom'. The default order is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/categories?order=isCustom,desc&order=name' will return all custom categories followed by all default categories. Both groups are ordered ascending by name. 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). @return PageableCategoryList diff --git a/api_client_configuration.go b/api_client_configuration.go index 7146740..468056b 100644 --- a/api_client_configuration.go +++ b/api_client_configuration.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/api_labels.go b/api_labels.go index 9d601c9..ea7fa1e 100644 --- a/api_labels.go +++ b/api_labels.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -595,7 +595,7 @@ Get labels of the user that is authorized by the access_token. Must pass the use * @param "Ids" (optional.Interface of []int64) - A comma-separated list of label identifiers. If specified, then only labels whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. * @param "Search" (optional.String) - If specified, then only those labels will be contained in the result whose 'name' contains the given search string (the matching works case-insensitive). If no labels contain the search string in their name, 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 name in order for a label to get included into the result. * @param "Page" (optional.Int32) - Result page that you want to retrieve - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. * @param "Order" (optional.Interface of []string) - Determines the order of the results. You can order the results by 'id' or 'name'. The default order for all services is 'id,asc'. Since both fields (id and name) are unique, ordering by multiple fields is pointless. The general format is: 'property[,asc|desc]', with 'asc' being the default value. @return PageableLabelList diff --git a/api_mandator_administration.go b/api_mandator_administration.go index 48e1a86..5c78a86 100644 --- a/api_mandator_administration.go +++ b/api_mandator_administration.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -473,7 +473,7 @@ Delete one or multiple IBAN rules that you have previously created via the ' @return IdentifierList */ -func (a *MandatorAdministrationApiService) DeleteIbanRules(ctx context.Context, body IdentifiersParams) (IdentifierList, *http.Response, error) { +func (a *MandatorAdministrationApiService) DeleteIbanRules(ctx context.Context, body IbanRuleIdentifiersParams) (IdentifierList, *http.Response, error) { var ( localVarHttpMethod = strings.ToUpper("Post") localVarPostBody interface{} @@ -618,7 +618,7 @@ Delete one or multiple keyword rules that you have previously created via the &# @return IdentifierList */ -func (a *MandatorAdministrationApiService) DeleteKeywordRules(ctx context.Context, body IdentifiersParams) (IdentifierList, *http.Response, error) { +func (a *MandatorAdministrationApiService) DeleteKeywordRules(ctx context.Context, body KeywordRuleIdentifiersParams) (IdentifierList, *http.Response, error) { var ( localVarHttpMethod = strings.ToUpper("Post") localVarPostBody interface{} @@ -895,7 +895,7 @@ Returns all IBAN-based categorization rules that you have defined for your users * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param optional nil or *GetIbanRuleListOpts - Optional Parameters: * @param "Page" (optional.Int32) - Result page that you want to retrieve - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. @return PageableIbanRuleList */ @@ -1041,7 +1041,7 @@ Returns all keyword-based categorization rules that you have defined for your us * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param optional nil or *GetKeywordRuleListOpts - Optional Parameters: * @param "Page" (optional.Int32) - Result page that you want to retrieve - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. @return PageableKeywordRuleList */ @@ -1196,10 +1196,11 @@ MandatorAdministrationApiService Get user list * @param "MonthlyStatsStartDate" (optional.String) - Minimum bound for the monthly stats (=oldest month that should be included). Must be passed in the format 'YYYY-MM'. If not specified, then the monthly stats will go back up to the first month in which the user existed (date of the user's registration). Note that this field is only regarded if 'includeMonthlyStats' = true. * @param "MonthlyStatsEndDate" (optional.String) - Maximum bound for the monthly stats (=latest month that should be included). Must be passed in the format 'YYYY-MM'. If not specified, then the monthly stats will go up to either the current month (for active users), or up to the month of deletion (for deleted users). Note that this field is only regarded if 'includeMonthlyStats' = true. * @param "MinBankConnectionCountInMonthlyStats" (optional.Int32) - A value of X means that the service will return only those users which had at least X bank connections imported at any time within the returned monthly stats set. This field is only regarded when 'includeMonthlyStats' is set to 'true'. The default value for this field is 0. + * @param "UserId" (optional.String) - The identifier of a user to search for. If specified, then only the user with the given id will be regarded. If no user can be found for the passed userId (because the user was deleted or his username was misspelled), then the result list will be empty. * @param "IsDeleted" (optional.Bool) - If NOT specified, then the service will regard both active and deleted users in the search. If set to 'true', then ONLY deleted users will be regarded. If set to 'false', then ONLY active users will be regarded. * @param "IsLocked" (optional.Bool) - If NOT specified, then the service will regard both locked and not locked users in the search. If set to 'true', then ONLY locked users will be regarded. If set to 'false', then ONLY not locked users will be regarded. * @param "Page" (optional.Int32) - Result page that you want to retrieve - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. * @param "Order" (optional.Interface of []string) - Determines the order of the results. You can order the results by 'userId'. The default order for this service is 'userId,asc'. The general format is: 'property[,asc|desc]', with 'asc' being the default value. @return PageableUserInfoList @@ -1216,6 +1217,7 @@ type GetUserListOpts struct { MonthlyStatsStartDate optional.String MonthlyStatsEndDate optional.String MinBankConnectionCountInMonthlyStats optional.Int32 + UserId optional.String IsDeleted optional.Bool IsLocked optional.Bool Page optional.Int32 @@ -1269,6 +1271,9 @@ func (a *MandatorAdministrationApiService) GetUserList(ctx context.Context, loca if localVarOptionals != nil && localVarOptionals.MinBankConnectionCountInMonthlyStats.IsSet() { localVarQueryParams.Add("minBankConnectionCountInMonthlyStats", parameterToString(localVarOptionals.MinBankConnectionCountInMonthlyStats.Value(), "")) } + if localVarOptionals != nil && localVarOptionals.UserId.IsSet() { + localVarQueryParams.Add("userId", parameterToString(localVarOptionals.UserId.Value(), "")) + } if localVarOptionals != nil && localVarOptionals.IsDeleted.IsSet() { localVarQueryParams.Add("isDeleted", parameterToString(localVarOptionals.IsDeleted.Value(), "")) } diff --git a/api_mocks_and_tests.go b/api_mocks_and_tests.go index daed73f..e0fb421 100644 --- a/api_mocks_and_tests.go +++ b/api_mocks_and_tests.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/api_notification_rules.go b/api_notification_rules.go index daa18f8..01a136a 100644 --- a/api_notification_rules.go +++ b/api_notification_rules.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/api_payments.go b/api_payments.go index fc49dd8..7c1ed41 100644 --- a/api_payments.go +++ b/api_payments.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -38,7 +38,7 @@ Get payments of the user that is authorized by the access_token. * @param "MinAmount" (optional.Float32) - If specified, then only those payments are regarded whose (absolute) total amount is equal or greater than the given amount will be regarded. The value must be a positive (absolute) amount. * @param "MaxAmount" (optional.Float32) - If specified, then only those payments are regarded whose (absolute) total amount is equal or less than the given amount will be regarded. Value must be a positive (absolute) amount. * @param "Page" (optional.Int32) - Result page that you want to retrieve - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. * @param "Order" (optional.Interface of []string) - Determines the order of the results. You can use the following fields for ordering the response: 'id', 'amount', 'requestDate' and 'executionDate'. The default order for all services is 'id,asc'. @return PageablePaymentResources diff --git a/api_securities.go b/api_securities.go index fdeb6b9..bf86342 100644 --- a/api_securities.go +++ b/api_securities.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -38,7 +38,7 @@ Get securities of the user that is authorized by the access_token. Must pass the * @param "Search" (optional.String) - If specified, then only those securities will be contained in the result whose 'name', 'isin' or 'wkn' contains the given search string (the matching works case-insensitive). If no securities 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 a security to get included into the result. * @param "AccountIds" (optional.Interface of []int64) - Comma-separated list of identifiers of accounts * @param "Page" (optional.Int32) - Result page that you want to retrieve. - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. * @param "Order" (optional.Interface of []string) - Determines the order of the results. You can order the results by next fields: 'id', 'name', 'isin', 'wkn', 'quote', 'quantityNominal', 'marketValue' and 'entryQuote'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. 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). @return PageableSecurityList diff --git a/api_tpp_certificates.go b/api_tpp_certificates.go index 41c4f32..f5a18c3 100644 --- a/api_tpp_certificates.go +++ b/api_tpp_certificates.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -293,7 +293,7 @@ Returns all certificates that you have uploaded via 'Create a new certificat * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param optional nil or *GetAllCertificatesOpts - Optional Parameters: * @param "Page" (optional.Int32) - Result page that you want to retrieve - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. @return PageableTppCertificateList */ diff --git a/api_tpp_credentials.go b/api_tpp_credentials.go index ea3f07a..0d8065d 100644 --- a/api_tpp_credentials.go +++ b/api_tpp_credentials.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -452,7 +452,7 @@ Get and search all TPP credentials. Must pass the <a href='https://f * @param optional nil or *GetAllTppCredentialsOpts - Optional Parameters: * @param "Search" (optional.String) - Returns only the TPP credentials belonging to those banks whose 'name', 'blz', or 'bic' contains the given search string (the matching works case-insensitive). Note: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must apply to a bank in order for it to get included into the result. * @param "Page" (optional.Int32) - Result page that you want to retrieve - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. @return PageableTppCredentialResources */ @@ -601,16 +601,18 @@ TPPCredentialsApiService Get all TPP Authentication Groups Get and search across all available TPP authentication groups. Must pass the <a href='https://finapi.zendesk.com/hc/en-us/articles/115003661827-Difference-between-app-clients-and-mandator-admin-client' target='_blank'>mandator admin client</a>'s access_token. You can set optional search criteria to get only those TPP authentication groups that you are interested in. If you do not specify any search criteria, then this service functions as a 'get all' service. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param optional nil or *GetAndSearchTppAuthenticationGroupsOpts - Optional Parameters: + * @param "Ids" (optional.Interface of []int64) - A comma-separated list of TPP authentication group identifiers. If specified, then only TPP authentication groups whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. * @param "Name" (optional.String) - Only the tpp authentication groups with name matching the given one should appear in the result list * @param "BankBlz" (optional.String) - Search by connected banks: only the banks with BLZ matching the given one should appear in the result list * @param "BankName" (optional.String) - Search by connected banks: only the banks with name matching the given one should appear in the result list * @param "Page" (optional.Int32) - Result page that you want to retrieve - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. @return PageableTppAuthenticationGroupResources */ type GetAndSearchTppAuthenticationGroupsOpts struct { + Ids optional.Interface Name optional.String BankBlz optional.String BankName optional.String @@ -634,6 +636,9 @@ func (a *TPPCredentialsApiService) GetAndSearchTppAuthenticationGroups(ctx conte localVarQueryParams := url.Values{} localVarFormParams := url.Values{} + if localVarOptionals != nil && localVarOptionals.Ids.IsSet() { + localVarQueryParams.Add("ids", parameterToString(localVarOptionals.Ids.Value(), "multi")) + } if localVarOptionals != nil && localVarOptionals.Name.IsSet() { localVarQueryParams.Add("name", parameterToString(localVarOptionals.Name.Value(), "")) } diff --git a/api_transactions.go b/api_transactions.go index d599d79..d3ce677 100644 --- a/api_transactions.go +++ b/api_transactions.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -814,7 +814,7 @@ Get transactions of the user that is authorized by the access_token. Must pass t * @param "MinImportDate" (optional.String) - Lower bound for a transaction's import date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only transactions whose 'importDate' is equal to or later than the given date will be regarded. * @param "MaxImportDate" (optional.String) - Upper bound for a transaction's import date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only transactions whose 'importDate' is equal to or earlier than the given date will be regarded. * @param "Page" (optional.Int32) - Result page that you want to retrieve. - * @param "PerPage" (optional.Int32) - 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. + * @param "PerPage" (optional.Int32) - Maximum number of records per page. By default it's 20. 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. * @param "Order" (optional.Interface of []string) - Determines the order of the results. You can use the following fields for ordering the response: 'id', 'parentId', 'accountId', 'valueDate', 'bankBookingDate', 'finapiBookingDate', 'amount', 'purpose', 'counterpartName', 'counterpartAccountNumber', 'counterpartIban', 'counterpartBlz', 'counterpartBic', 'type', 'primanota', 'category.id', 'category.name', 'isPotentialDuplicate', 'isNew' and 'importDate'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/transactions?order=finapiBookingDate,desc&order=counterpartName' will return the latest transactions first. If there are more transactions on the same day, then these transactions are ordered by the counterpart name (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). @return PageableTransactionList diff --git a/api_users.go b/api_users.go index 7f4a1fd..639956c 100644 --- a/api_users.go +++ b/api_users.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/api_web_forms.go b/api_web_forms.go index 7b4acaa..0108a87 100644 --- a/api_web_forms.go +++ b/api_web_forms.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/client.go b/client.go index 8240d6a..6efcd9a 100644 --- a/client.go +++ b/client.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -37,7 +37,7 @@ var ( xmlCheck = regexp.MustCompile("(?i:[application|text]/xml)") ) -// APIClient manages communication with the finAPI RESTful Services API vv1.79.0 +// APIClient manages communication with the finAPI RESTful Services API vv1.93.0 // In most cases there should be only one, shared, APIClient. type APIClient struct { cfg *Configuration @@ -88,7 +88,12 @@ type service struct { // optionally a custom http.Client to allow for advanced features such as caching. func NewAPIClient(cfg *Configuration) *APIClient { if cfg.HTTPClient == nil { - cfg.HTTPClient = http.DefaultClient + cfg.HTTPClient = &http.Client{ + // The AWS ALB will terminate the connection (e.g. to legacy) after 60s so there is no point + // in waiting longer than that for finAPI. Even when they would respond later we could not send + // the response anymore. + Timeout: 55 * time.Second, + } } c := &APIClient{} diff --git a/configuration.go b/configuration.go index 1ee9ed0..15936bf 100644 --- a/configuration.go +++ b/configuration.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/docs/AccessToken.md b/docs/AccessToken.md index 908808d..c896fee 100644 --- a/docs/AccessToken.md +++ b/docs/AccessToken.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes **TokenType** | **string** | Token type (it's always 'bearer') | [default to null] **Scope** | **string** | Requested scopes (it's always 'all') | [default to null] **RefreshToken** | **string** | Refresh token. Only set in case of grant_type='password'. Token has a length of up to 128 characters. | [optional] [default to null] -**AccessToken** | **string** | Access token. Token has a length of up to 128 characters. | [default to null] **ExpiresIn** | **int32** | Expiration time in seconds. A value of 0 means that the token never expires (unless it is explicitly invalidated, e.g. by revocation, or when a user gets locked). | [default to null] +**AccessToken** | **string** | Access token. Token has a length of up to 128 characters. | [default to null] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AccountsApi.md b/docs/AccountsApi.md index 0605134..81c431c 100644 --- a/docs/AccountsApi.md +++ b/docs/AccountsApi.md @@ -256,7 +256,7 @@ Name | Type | Description | Notes **endDate** | **optional.String**| 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. | **withProjection** | **optional.Bool**| Whether finAPI should project the first and last actually existing balance of an account 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 regarded accounts, and only up to the day where the last actual balance exists for any of the regarded 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'. | [default to true] **page** | **optional.Int32**| Result page that you want to retrieve. | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] **order** | [**optional.Interface of []string**](string.md)| 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). | ### Return type diff --git a/docs/Bank.md b/docs/Bank.md index b888090..500eaec 100644 --- a/docs/Bank.md +++ b/docs/Bank.md @@ -11,10 +11,10 @@ Name | Type | Description | Notes **Blz** | **string** | BLZ of bank | [default to null] **Location** | **string** | Bank location (two-letter country code; ISO 3166 ALPHA-2). Note that when this field is not set, it means that this bank depicts an international institute which is not bound to any specific country. | [optional] [default to null] **City** | **string** | City that this bank is located in. Note that this field may not be set for some banks. | [optional] [default to null] -**IsSupported** | **bool** | Whether this bank is supported by finAPI, i.e. whether you can import/update a bank connection of this bank.<br><br>NOTE: This field is deprecated and will be removed at some point. Please refer to field 'interfaces' instead. | [default to null] +**IsSupported** | **bool** | THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Please refer to field 'interfaces' instead.<br/><br/>Whether this bank is supported by finAPI, i.e. whether you can import/update a bank connection of this bank. | [default to null] **IsTestBank** | **bool** | If true, then this bank does not depict a real bank, but rather a testing endpoint provided by a bank or by finAPI. You probably want to regard these banks only during the development of your application, but not in production. You can filter out these banks in production by making sure that the 'isTestBank' parameter is always set to 'false' whenever your application is calling the 'Get and search all banks' service. | [default to null] **Popularity** | **int32** | Popularity of this bank with your users (mandator-wide, i.e. across all of your clients). The value equals the number of bank connections that are currently imported for this bank across all of your users (which means it is a constantly adjusting value). You can use this field for statistical evaluation, and also for ordering bank search results (see service 'Get and search all banks'). | [default to null] -**Health** | **int32** | The health status of this bank. This is a value between 0 and 100, depicting the percentage of successful communication attempts with this bank during the latest couple of bank connection imports or updates (across the entire finAPI system). Note that 'successful' 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. | [default to null] +**Health** | **int32** | THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'health' in the 'interfaces' instead. <br/><br/>The health status of this bank. This is a value between 0 and 100, depicting the percentage of successful communication attempts with this bank during the latest couple of bank connection imports or updates (across the entire finAPI system). Note that 'successful' 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. | [default to null] **LoginFieldUserId** | **string** | THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'loginCredentials' in the 'interfaces' instead.<br/><br/>Label for the user ID login field, as it is called on the bank's website (e.g. \"Nutzerkennung\"). If this field is set (i.e. not null) then you should prompt your users to enter the required data in a text field which you can label with this field's value. | [optional] [default to null] **LoginFieldCustomerId** | **string** | THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'loginCredentials' in the 'interfaces' instead.<br/><br/>Label for the customer ID login field, as it is called on the bank's website (e.g. \"Kundennummer\"). If this field is set (i.e. not null) then you should prompt your users to enter the required data in a text field which you can label with this field's value. | [optional] [default to null] **LoginFieldPin** | **string** | THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'loginCredentials' in the 'interfaces' instead.<br/><br/>Label for the PIN field, as it is called on the bank's website (mostly \"PIN\"). If this field is set (i.e. not null) then you should prompt your users to enter the required data in a text field which you can label with this field's value. | [optional] [default to null] @@ -22,8 +22,8 @@ Name | Type | Description | Notes **IsCustomerIdPassword** | **bool** | THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'isSecret' field of the 'loginCredentials' in 'interfaces' instead.<br/><br/>Whether the banking customer ID has to be treated like a password. Certain banks require a second password (besides the PIN) for the user to login. In this case your application should use a password input field when prompting users for their credentials.<br><br>NOTE: This field is deprecated and will be removed at some point. | [default to null] **SupportedDataSources** | **[]string** | THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'interfaces' instead.<br/><br/>List of the data sources that finAPI will use for data download for this bank. Possible values:<br><br>&bull; <code>FINTS_SERVER</code> - means that finAPI will download data via the bank's FinTS interface.<br>&bull; <code>WEB_SCRAPER</code> - means that finAPI will parse data from the bank's online banking website.<br><br>Note that this list will be empty for non-supported banks. Note also that web scraping might be disabled for your client (see GET /clientConfiguration). When this is the case, then finAPI will not use the web scraper for data download, and if the web scraper is the only supported data source of this bank, then finAPI will not allow to download any data for this bank at all (for details, see POST /bankConnections/import and POST /bankConnections/update). | [default to null] **Interfaces** | [**[]BankInterface**](BankInterface.md) | Set of interfaces that finAPI can use to connect to the bank. Note that this set will be empty for non-supported banks. Note also that the WEB_SCRAPER interface might be disabled for your client (see GET /clientConfiguration). When this is the case, then finAPI will not use the web scraper for data download, and if the web scraper is the only supported interface of this bank, then finAPI will not allow to download any data for this bank at all (for details, see POST /bankConnections/import and POST /bankConnections/update). | [optional] [default to null] -**LastCommunicationAttempt** | **string** | Time of the last communication attempt with this bank during a bank connection import or update (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). | [optional] [default to null] -**LastSuccessfulCommunication** | **string** | Time of the last successful communication with this bank during a bank connection import or update (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). | [optional] [default to null] +**LastCommunicationAttempt** | **string** | THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'lastCommunicationAttempt' in the 'interfaces' instead. <br/><br/>Time of the last communication attempt with this bank during a bank connection import or update (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). | [optional] [default to null] +**LastSuccessfulCommunication** | **string** | THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'lastSuccessfulCommunication' in the 'interfaces' instead. <br/><br/>Time of the last successful communication with this bank during a bank connection import or update (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). | [optional] [default to null] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BankConnection.md b/docs/BankConnection.md index 8628a90..95fd486 100644 --- a/docs/BankConnection.md +++ b/docs/BankConnection.md @@ -17,13 +17,13 @@ Name | Type | Description | Notes **IbanOnlyMoneyTransferSupported** | **bool** | NOTE: This field is deprecated and will be removed at some point. Please refer to the account capabilities instead.<br><br>Whether this bank connection accepts money transfer requests where the recipient's account is defined just by the IBAN (without an additional BIC). This field is re-evaluated each time this bank connection is updated. <br/>See also: /accounts/requestSepaMoneyTransfer | [default to null] **IbanOnlyDirectDebitSupported** | **bool** | NOTE: This field is deprecated and will be removed at some point. Please refer to the account capabilities instead.<br><br>Whether this bank connection accepts direct debit requests where the debitor's account is defined just by the IBAN (without an additional BIC). This field is re-evaluated each time this bank connection is updated. <br/>See also: /accounts/requestSepaDirectDebit | [default to null] **CollectiveMoneyTransferSupported** | **bool** | NOTE: This field is deprecated and will be removed at some point. Please refer to the account capabilities instead.<br><br>Whether this bank connection supports submitting collective money transfers. This field is re-evaluated each time this bank connection is updated. <br/>See also: /accounts/requestSepaMoneyTransfer | [default to null] -**DefaultTwoStepProcedureId** | **string** | NOTE: This field is deprecated and will be removed at some point. Please refer to corresponding field in 'interfaces' instead.<br><br>The default two-step-procedure. Must match one of the available 'procedureId's from the 'twoStepProcedures' list. When this field is set, you can execute two-step-procedures (accounts/requestSepaMoneyTransfer or /requestSepaDirectDebit) without having to explicitly set a procedure. finAPI will use the default procedure in such cases. Note that the list of available procedures of a bank connection may change as a result of an update of the connection, and if this field references a procedure that is no longer available after an update, finAPI will automatically clear the default procedure (set it to null).s | [optional] [default to null] +**DefaultTwoStepProcedureId** | **string** | NOTE: This field is deprecated and will be removed at some point. Please refer to corresponding field in 'interfaces' instead.<br><br>The default two-step-procedure. Must match one of the available 'procedureId's from the 'twoStepProcedures' list. When this field is set, then finAPI will automatically try to select the procedure wherever applicable. Note that the list of available procedures of a bank connection may change as a result of an update of the connection, and if this field references a procedure that is no longer available after an update, finAPI will automatically clear the default procedure (set it to null). | [optional] [default to null] **TwoStepProcedures** | [**[]TwoStepProcedure**](TwoStepProcedure.md) | NOTE: This field is deprecated and will be removed at some point. Please refer to corresponding field in 'interfaces' instead.<br><br>Available two-step-procedures for this bank connection, used for submitting a money transfer or direct debit request (see /accounts/requestSepaMoneyTransfer or /requestSepaDirectDebit). The available two-step-procedures are re-evaluated each time this bank connection is updated (/bankConnections/update). This means that this list may change as a result of an update. | [optional] [default to null] **Interfaces** | [**[]BankConnectionInterface**](BankConnectionInterface.md) | Set of interfaces that are connected for this bank connection. | [optional] [default to null] **AccountIds** | **[]int64** | Identifiers of the accounts that belong to this bank connection | [default to null] **Owners** | [**[]BankConnectionOwner**](BankConnectionOwner.md) | Information about the owner(s) of the bank connection | [optional] [default to null] **Bank** | [***Bank**](Bank.md) | Bank that this connection belongs to | [default to null] -**FurtherLoginNotRecommended** | **bool** | This field indicates whether the last communication with the bank failed with an error that requires the user's attention. If 'furtherLoginNotRecommended' is true, finAPI will stop auto updates of this bank connection to mitigate the risk of the user's bank account getting locked by the bank. Every communication with the bank (via updates, money_transfers, direct debits. etc.) can change the value of this flag. If this field is true, we recommend the user to check his credentials and try a manual update of the bank connection. If the update is successful, the 'furtherLoginNotRecommended' field will be set to false and the bank connection will be reincluded in the next batch update process. A manual update of the bank connection with incorrect credentials will set this field to true and lead to the exclusion of the bank connection from the following batch updates. | [default to null] +**FurtherLoginNotRecommended** | **bool** | This field indicates whether the last communication with the bank failed with an error that requires the user's attention or multi-step authentication error. If 'furtherLoginNotRecommended' is true, finAPI will stop auto updates of this bank connection to mitigate the risk of the user's bank account getting locked by the bank. Every communication with the bank (via updates, money_transfers, direct debits. etc.) can change the value of this flag. If this field is true, we recommend the user to check his credentials and try a manual update of the bank connection. If the update is successful without any multi-step authentication error, the 'furtherLoginNotRecommended' field will be set to false and the bank connection will be reincluded in the next batch update process. A manual update of the bank connection with incorrect credentials or if multi-step authentication error happens will set this field to true and lead to the exclusion of the bank connection from the following batch updates. | [default to null] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BankConnectionsApi.md b/docs/BankConnectionsApi.md index 571c2aa..409c875 100644 --- a/docs/BankConnectionsApi.md +++ b/docs/BankConnectionsApi.md @@ -220,7 +220,7 @@ Name | Type | Description | Notes > BankConnection ImportBankConnection(ctx, body) Import a new bank connection -Imports a new bank connection for a specific user. Must pass the connection credentials and the user's access_token. All bank accounts will be downloaded and imported with their current balances, transactions and supported two-step-procedures (note that the amount of available transactions may vary between banks, e.g. some banks deliver all transactions from the past year, others only deliver the transactions from the past three months). The balance and transactions download process runs asynchronously, so this service may return before all balances and transactions have been imported. Also, all downloaded transactions will be categorized by a separate background process that runs asynchronously too. To check the status of the balance and transactions download process as well as the background categorization process, see the status flags that are returned by the GET /bankConnections/ service.

You can also import a \"demo connection\" which contains a single bank account with some pre-defined transactions. To import the demo connection, you need to pass the identifier of the \"finAPI Test Bank\". In case of demo connection import, any other fields besides the bank identifier can remain unset. The bankingUserId, bankingCustomerId, bankingPin, and storeSecrets fields will be stored if you pass them, however they will not be regarded when updating the demo connection (in other words: It doesn't matter what credentials you choose for the demo connection). Note however that if you want to import the demo connection multiple times for the same user, you must use a different bankingUserId and/or bankingCustomerId for each of the imports. Also note that the skipPositionsDownload flag is ignored for the demo bank connection, i.e. when importing the demo bank connection, you will always get the transactions for its account. You can enable multi-step authentication for the demo bank connection by setting the bank connection name to \"MSA\".

For a more in-depth understanding of the import process, please also read this article on our Dev Portal: Import & Update of Bank Connections / Accounts

NOTE: Depending on your license, this service may respond with HTTP code 451, containing an error message with a identifier of web form in it. In addition to that the response will also have included a 'Location' header, which contains the URL to the web form. In this case, you must forward your user to finAPI's web form. For a detailed explanation of the Web Form Flow, please refer to this article: finAPI's Web Form Flow

Attention: Due to changes on the bank's side we have been forced to limit the maxDaysForDownload field to 89 days. Now any import or update of a bank connection will only fetch the last three months of transactions per account, regardless if maxDaysForDownload is defined or not. We're working of fixing this behaviour by implementing the multi step authentication workflow for FinTS. +Imports a new bank connection for a specific user. Must pass the connection credentials and the user's access_token. All bank accounts will be downloaded and imported with their current balances, transactions and supported two-step-procedures (note that the amount of available transactions may vary between banks, e.g. some banks deliver all transactions from the past year, others only deliver the transactions from the past three months). The balance and transactions download process runs asynchronously, so this service may return before all balances and transactions have been imported. Also, all downloaded transactions will be categorized by a separate background process that runs asynchronously too. To check the status of the balance and transactions download process as well as the background categorization process, see the status flags that are returned by the GET /bankConnections/ service.

You can also import a \"demo connection\" which contains a single bank account with some pre-defined transactions. To import the demo connection, you need to pass the identifier of the \"finAPI Test Bank\". In case of demo connection import, any other fields besides the bank identifier can remain unset. The bankingUserId, bankingCustomerId, bankingPin, and storeSecrets fields will be stored if you pass them, however they will not be regarded when updating the demo connection (in other words: It doesn't matter what credentials you choose for the demo connection). Note however that if you want to import the demo connection multiple times for the same user, you must use a different bankingUserId and/or bankingCustomerId for each of the imports. Also note that the skipPositionsDownload flag is ignored for the demo bank connection, i.e. when importing the demo bank connection, you will always get the transactions for its account. You can enable multi-step authentication for the demo bank connection by setting the bank connection name to \"MSA\".

The XS2A interface could also be used to initiate a demo connection import.
The finAPI demo XS2A allows you to download a test account by using the 'import' or 'connectInterface' services - in general, this XS2A demo account is the FINTS_SERVER demo account, as it has the same account number and origin of balances and transactions.
Keep in mind, that calling an XS2A demo connection import will result as a newly created bank connection, when the 'connectInterface' service attaches the XS2A demo account to an existing demo connection.
Passing the login credentials is not obligated only for redirect banks, however the demo bank works without any given set of credentials for the XS2A interface. The old API credentials fields (bankingUserId, bankingCustomerId, bankingPin) are DEPRECATED and temporarily mapped on the new credentials data structure, allowing you to use them within the XS2A import. This is not recommended, as those fields are going to be removed at some point later.
If you are looking to test the XS2A SCA (Strong Customer Authentication, or MSA (Multi-Step Authentication) in the finAPI context), you need to pass the bank connection name as \"MSA\" to trigger the SCA flow or as 'DECOUPLED-AUTH' to simulate decoupled authentication. To get better understanding about the Multi-Step Authentication, please refer to the 'Error Messages' section of the swagger documentation.

For a more in-depth understanding of the import process, please also read this article on our Dev Portal: Import & Update of Bank Connections / Accounts

NOTE: Depending on your license, this service may respond with HTTP code 451, containing an error message with a identifier of web form in it. In addition to that the response will also have included a 'Location' header, which contains the URL to the web form. In this case, you must forward your user to finAPI's web form. For a detailed explanation of the Web Form Flow, please refer to this article: finAPI's Web Form Flow

Attention: Due to changes on the bank's side we have been forced to limit the maxDaysForDownload field to 89 days to reduce the risk of strong customer authentication (SCA) requests. If you have implemented the SCA flow, please contact us, so that we can remove this limitation from your client. ### Required Parameters @@ -276,7 +276,7 @@ Name | Type | Description | Notes > BankConnection UpdateBankConnection(ctx, body) Update a bank connection -Update an existing bank connection of the user that is authorized by the access_token. Downloads and imports the current account balances and new transactions. Must pass the connection's identifier and the user's access_token. For more information about the processes of authentication, data download and transactions categorization, see POST /bankConnections/import. Note that supported two-step-procedures are updated as well. It may unset the current default two-step-procedure of the given bank connection (but only if this procedure is not supported anymore by the bank). You can also update the \"demo connection\" (in this case, the fields 'bankingPin', 'importNewAccounts', and 'skipPositionsDownload' will be ignored).

Note that you cannot trigger an update of a bank connection as long as there is still a previously triggered update running.

For a more in-depth understanding of the update process, please also read this article on our Dev Portal: Import & Update of Bank Connections / Accounts

NOTE: Depending on your license, this service may respond with HTTP code 451, containing an error message with a identifier of web form in it. In addition to that the response will also have included a 'Location' header, which contains the URL to the web form. In this case, you must forward your user to finAPI's web form. For a detailed explanation of the Web Form Flow, please refer to this article: finAPI's Web Form Flow

Attention: Due to changes on the bank's side we have been forced to limit the maxDaysForDownload field to 89 days. Now any import or update of a bank connection will only fetch the last three months of transactions per account, regardless if maxDaysForDownload is defined or not. We're working of fixing this behaviour by implementing the multi step authentication workflow for FinTS. +Update an existing bank connection of the user that is authorized by the access_token. Downloads and imports the current account balances and new transactions. Note that if the bank connection has several interfaces and some of its accounts was previously imported or updated via an interface which have higher priority than the interface used in the current update, then balances and transactions will not be downloaded for such accounts (The XS2A interface has the highest priority, followed by FINTS_SERVER and finally WEB_SCRAPER). Must pass the connection's identifier and the user's access_token. For more information about the processes of authentication, data download and transactions categorization, see POST /bankConnections/import. Note that supported two-step-procedures are updated as well. It may unset the current default two-step-procedure of the given bank connection (but only if this procedure is not supported anymore by the bank). You can also update the \"demo connection\" (in this case, the fields 'bankingPin', 'importNewAccounts', and 'skipPositionsDownload' will be ignored).

Note that you cannot trigger an update of a bank connection as long as there is still a previously triggered update running.

For a more in-depth understanding of the update process, please also read this article on our Dev Portal: Import & Update of Bank Connections / Accounts

NOTE: Depending on your license, this service may respond with HTTP code 451, containing an error message with a identifier of web form in it. In addition to that the response will also have included a 'Location' header, which contains the URL to the web form. In this case, you must forward your user to finAPI's web form. For a detailed explanation of the Web Form Flow, please refer to this article: finAPI's Web Form Flow

Attention: Due to changes on the bank's side we have been forced to limit the transaction download time frame to 89 days. Now any update of a bank connection will fetch the last three months of transactions per account. If the last successful update was more than 3 months ago, an adjusting entry ('Zwischensaldo' transaction) will be created. ### Required Parameters diff --git a/docs/BankInterface.md b/docs/BankInterface.md index 49db137..69dac13 100644 --- a/docs/BankInterface.md +++ b/docs/BankInterface.md @@ -6,8 +6,11 @@ Name | Type | Description | Notes **Interface_** | **string** | Bank interface. Possible values:<br><br>&bull; <code>FINTS_SERVER</code> - means that finAPI will download data via the bank's FinTS server.<br>&bull; <code>WEB_SCRAPER</code> - means that finAPI will parse data from the bank's online banking website.<br>&bull; <code>XS2A</code> - means that finAPI will download data via the bank's XS2A interface.<br> | [default to null] **TppAuthenticationGroup** | [***TppAuthenticationGroup**](TppAuthenticationGroup.md) | TPP Authentication Group which the bank interface is connected to | [optional] [default to null] **LoginCredentials** | [**[]BankInterfaceLoginField**](BankInterfaceLoginField.md) | Login credentials fields which should be shown to the user. | [default to null] -**Properties** | **[]string** | Set of interface properties/specifics. Possible values:<br><br>&bull; <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.<br/><br/>&bull; <code>DECOUPLED_APPROACH</code> - means that the interface uses a decoupled approach when authorizing the user.<br/><br/>&bull; <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 can be empty, if the interface does not have any specific properties. | [optional] [default to null] +**Properties** | **[]string** | Set of interface properties/specifics. Possible values:<br><br>&bull; <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: &lt;account list&gt;. Are you sure that you want to import another bank connection from &lt;bank name&gt;? </blockquote>&bull; <code>DECOUPLED_APPROACH</code> - means that the interface uses a decoupled approach when authorizing the user.<br/><br/>&bull; <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 can be empty, if the interface does not have any specific properties. | [optional] [default to null] **LoginHint** | **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] [default to null] +**Health** | **int32** | 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 latest couple of bank connection imports or updates (across the entire finAPI system). Note that 'successful' 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. | [default to null] +**LastCommunicationAttempt** | **string** | Time of the last communication attempt with this interface during an import, update or connect interface (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). | [optional] [default to null] +**LastSuccessfulCommunication** | **string** | Time of the last successful communication with this interface during an import, update or connect interface (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). | [optional] [default to null] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BanksApi.md b/docs/BanksApi.md index 72af3f8..122bcbc 100644 --- a/docs/BanksApi.md +++ b/docs/BanksApi.md @@ -37,7 +37,7 @@ Name | Type | Description | Notes **tppAuthenticationGroupIds** | [**optional.Interface of []int64**](int64.md)| A comma-separated list of TPP authentication group identifiers. If specified, then only banks who have at least one interface belonging to one of the given groups will be regarded. The maximum number of identifiers is 1000. | **isTestBank** | **optional.Bool**| If specified, then only those banks will be regarded that have the given value (true or false) for their 'isTestBank' field. | **page** | **optional.Int32**| Result page that you want to retrieve. | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] **order** | [**optional.Interface of []string**](string.md)| Determines the order of the results. You can order the results by 'id', 'name', 'blz', 'bic' or 'popularity'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/banks?order=name,desc&order=id,asc' will return banks ordered by 'name' (descending), where banks with the same 'name' are ordered by 'id' (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). | ### Return type diff --git a/docs/CategoriesApi.md b/docs/CategoriesApi.md index 3c09b18..abb92e9 100644 --- a/docs/CategoriesApi.md +++ b/docs/CategoriesApi.md @@ -161,7 +161,7 @@ Name | Type | Description | Notes **search** | **optional.String**| If specified, then only those categories will be contained in the result whose 'name' contains the given search string (the matching works case-insensitive). If no categories contain the search string in their name, 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 name in order for a category to get included into the result. | **isCustom** | **optional.Bool**| If specified, then the result will contain only categories that are either finAPI global (in case of value 'false'), or only categories that have been created by the authorized user (in case of value 'true'). | **page** | **optional.Int32**| Result page that you want to retrieve. | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] **order** | [**optional.Interface of []string**](string.md)| Determines the order of the results. You can order the results by 'id', 'name' and 'isCustom'. The default order is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/categories?order=isCustom,desc&order=name' will return all custom categories followed by all default categories. Both groups are ordered ascending by name. 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). | ### Return type diff --git a/docs/ClientConfiguration.md b/docs/ClientConfiguration.md index 7644245..2d23e69 100644 --- a/docs/ClientConfiguration.md +++ b/docs/ClientConfiguration.md @@ -13,11 +13,13 @@ Name | Type | Description | Notes **IsUserAutoVerificationEnabled** | **bool** | Whether users that are created with this client are automatically verified on creation. If this field is set to 'false', then any user that is created with this client must first be verified with the \"Verify a user\" service before he can be authorized. If the field is 'true', then no verification is required by the client and the user can be authorized immediately after creation. | [default to null] **IsMandatorAdmin** | **bool** | Whether this client is a 'Mandator Admin'. Mandator Admins are special clients that can access the 'Mandator Administration' section of finAPI. If you do not yet have credentials for a Mandator Admin, please contact us at support@finapi.io. For further information, please refer to <a href='https://finapi.zendesk.com/hc/en-us/articles/115003661827-Difference-between-app-clients-and-mandator-admin-client' target='_blank'>this article</a> on our Dev Portal. | [default to null] **IsWebScrapingEnabled** | **bool** | Whether finAPI is allowed to use the WEB_SCRAPER interface for data download. If this field is set to 'true', then finAPI might download data from the online banking websites of banks (either in addition to other interfaces, or as the sole data source for the download). If this field is set to 'false', then finAPI will not use any web scrapers. For banks where no other interface except WEB_SCRAPER is available, finAPI will not allow any data download at all if web scraping is disabled for your client. Please contact your Sys-Admin if you want to change this setting. | [default to null] -**IsXs2aEnabled** | **bool** | Whether this client is allowed to access XS2A services. | [default to null] +**IsXs2aEnabled** | **bool** | NOTE: This field is deprecated and will be removed at some point.<br><br>Whether this client is allowed to access XS2A services. | [default to null] **AvailableBankGroups** | **[]string** | List of bank groups that are available to this client. A bank group is a collection of all banks that are located in a certain country, and is defined by the country's ISO 3166 ALPHA-2 code (see also field 'location' of Bank resource). If you want to extend or limit the available bank groups for your client, please contact your Sys-Admin.<br/><br/>Note: There is no bank group for international institutes (i.e. institutes that are not bound to any specific country). Instead, those institutes are always available. If this list is empty, it means that ONLY international institutes are available. | [default to null] **ApplicationName** | **string** | Application name. When an application name is set (e.g. \"My App\"), then <a href='https://finapi.zendesk.com/hc/en-us/articles/360002596391' target='_blank'>finAPI's web form</a> will display a text to the user \"Weiterleitung auf finAPI von ...\" (e.g. \"Weiterleitung auf finAPI von MyApp\"). | [optional] [default to null] **FinTSProductRegistrationNumber** | **string** | The FinTS product registration number. If a value is stored, this will always be 'XXXXX'. | [optional] [default to null] **StoreSecretsAvailableInWebForm** | **bool** | Whether <a href='https://finapi.zendesk.com/hc/en-us/articles/360002596391' target='_blank'>finAPI's web form</a> will provide a checkbox for the user allowing him to choose whether to store login secrets (like a PIN) in finAPI. If this field is set to false, then the user won't have an option to store this data. | [default to null] +**SupportSubjectDefault** | **string** | Default value for the subject element of support emails. | [optional] [default to null] +**SupportEmail** | **string** | Email address to sent support requests to from the web form. | [optional] [default to null] **PinStorageAvailableInWebForm** | **bool** | Whether <a href='https://finapi.zendesk.com/hc/en-us/articles/360002596391' target='_blank'>finAPI's web form</a> will provide a checkbox for the user allowing him to choose whether to store his banking PIN in finAPI. If this field is set to false, then the user won't have an option to store his PIN.<br><br>NOTE: This field is deprecated and will be removed at some point. Refer to field 'storeSecretsAvailableInWebForm' instead. | [default to null] **PaymentsEnabled** | **bool** | Whether this client is allowed to do payments | [default to null] diff --git a/docs/ClientConfigurationParams.md b/docs/ClientConfigurationParams.md index f93d357..3ec8470 100644 --- a/docs/ClientConfigurationParams.md +++ b/docs/ClientConfigurationParams.md @@ -12,6 +12,8 @@ Name | Type | Description | Notes **StoreSecretsAvailableInWebForm** | **bool** | Whether <a href='https://finapi.zendesk.com/hc/en-us/articles/360002596391' target='_blank'>finAPI's web form</a> will provide a checkbox for the user allowing him to choose whether to store login secrets (like a PIN) in finAPI. If this field is set to false, then the user won't have an option to store this data. | [optional] [default to null] **ApplicationName** | **string** | When an application name is set (e.g. \"My App\"), then <a href='https://finapi.zendesk.com/hc/en-us/articles/360002596391' target='_blank'>finAPI's web form</a> will display a text to the user \"Weiterleitung auf finAPI von ...\" (e.g. \"Weiterleitung auf finAPI von My App\"). If you have previously set a application name and now want to clear it, you can pass an empty string (\"\"). Maximum length: 64 | [optional] [default to null] **FinTSProductRegistrationNumber** | **string** | The FinTS product registration number. Please follow <a href='https://www.hbci-zka.de/register/prod_register.htm' target='_blank'>this link</a> to apply for a registration number. Only customers who have an AISP or PISP license must define their FinTS product registration number. Customers who are relying on the finAPI web form will be assigned to finAPI's FinTS product registration number automatically and do not have to register themselves. During a batch update, finAPI is using the FinTS product registration number of the client, that was used to create the user. If you have previously set a FinTS product registration number and now want to clear it, you can pass an empty string (\"\"). Only hexa decimal characters in capital case with a maximum length of 25 characters are allowed. E.g. 'ABCDEF1234567890ABCDEF123' | [optional] [default to null] +**SupportSubjectDefault** | **string** | Default value for the subject element of support emails. Maximum length is 100. Pass an empty string ('') if you want to clear the current subject default value. | [optional] [default to null] +**SupportEmail** | **string** | Email address to sent support requests to from the web form. Maximum length is 320. Pass an empty string ('') if you want to clear the current email address. | [optional] [default to null] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/EditBankConnectionParams.md b/docs/EditBankConnectionParams.md index a431de0..1e49372 100644 --- a/docs/EditBankConnectionParams.md +++ b/docs/EditBankConnectionParams.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | New name for the bank connection. Maximum length is 64. If you do not want to change the current name let this field remain unset. If you want to clear the current name, set the field's value to an empty string (\"\"). | [optional] [default to null] -**BankingUserId** | **string** | NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.<br><br>New online banking user ID. If you do not want to change the current user ID let this field remain unset. In case you need to use finAPI's web form to let the user update the field, just set the field to any value, so that the service recognizes that you wish to use the web form flow. Note that you cannot clear the current user ID, i.e. a bank connection must always have a user ID (except for when it is a 'demo connection'). Max length: 64. | [optional] [default to null] -**BankingCustomerId** | **string** | NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.<br><br>New online banking customer ID. If you do not want to change the current customer ID let this field remain unset. In case you need to use finAPI's web form to let the user update the field, just set the field to non-empty value, so that the service recognizes that you wish to use the web form flow. If you want to clear the current customer ID, set the field's value to an empty string (\"\"). Max length: 64. | [optional] [default to null] +**BankingUserId** | **string** | NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.<br><br>New online banking user ID. If you do not want to change the current user ID let this field remain unset. In case you need to use finAPI's web form to let the user update the field, just set the field to any value, so that the service recognizes that you wish to use the web form flow. Note that you cannot clear the current user ID, i.e. a bank connection must always have a user ID (except for when it is a 'demo connection'). Max length: 170. | [optional] [default to null] +**BankingCustomerId** | **string** | NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.<br><br>New online banking customer ID. If you do not want to change the current customer ID let this field remain unset. In case you need to use finAPI's web form to let the user update the field, just set the field to non-empty value, so that the service recognizes that you wish to use the web form flow. If you want to clear the current customer ID, set the field's value to an empty string (\"\"). Max length: 170. | [optional] [default to null] **BankingPin** | **string** | NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.<br><br>New online banking PIN. If you do not want to change the current PIN let this field remain unset. In case you need to use finAPI's web form to let the user update the field, just set the field to non-empty value, so that the service recognizes that you wish to use the web form flow. If you want to clear the current PIN, set the field's value to an empty string (\"\").<br/><br/>Any symbols are allowed. Max length: 170. | [optional] [default to null] **Interface_** | **string** | The interface for which you want to edit data. Must be given when you pass 'loginCredentials' and/or a 'defaultTwoStepProcedureId'. | [optional] [default to null] **LoginCredentials** | [**[]LoginCredential**](LoginCredential.md) | Set of login credentials that you want to edit. Must be passed in combination with the 'interface' field. The labels that you pass must match with the login credential labels that the respective interface defines. If you want to clear the stored value for a credential, you can pass an empty string (\"\") as value.In case you need to use finAPI's web form to let the user update the login credentials, send all fields the user wishes to update with a non-empty value.In case all fields contain an empty string (\"\"), no webform will be generated. Note that any change in the credentials will automatically remove the saved consent data associated with those credentials.<br><br>NOTE: When you pass this field, then the fields 'bankingUserId','bankingCustomerId' and 'bankingPin' will be ignored. | [optional] [default to null] diff --git a/docs/ErrorDetails.md b/docs/ErrorDetails.md index 9802269..e373821 100644 --- a/docs/ErrorDetails.md +++ b/docs/ErrorDetails.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Message** | **string** | Error message | [optional] [default to null] **Code** | **string** | Error code. See the documentation of the individual services for details about what values may be returned. | [default to null] -**Type_** | **string** | Error type. BUSINESS errors depict German error messages for the user, e.g. from a bank server. TECHNICAL errors depict internal errors. | [default to null] +**Type_** | **string** | Error type. BUSINESS errors depict error messages in the language of the bank (or the preferred language) for the user, e.g. from a bank server. TECHNICAL errors are meant to be read by developers and depict internal errors. | [default to null] **MultiStepAuthentication** | [***MultiStepAuthenticationChallenge**](MultiStepAuthenticationChallenge.md) | This field is set when a multi-step authentication is required, i.e. when you need to repeat the original service call and provide additional data. The field contains information about what additional data is required. | [optional] [default to null] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ExecutePasswordChangeParams.md b/docs/ExecutePasswordChangeParams.md index 1d288aa..7785d1e 100644 --- a/docs/ExecutePasswordChangeParams.md +++ b/docs/ExecutePasswordChangeParams.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **UserId** | **string** | User identifier | [default to null] -**Password** | **string** | User's new password. Minimum length is 6, and maximum length is 36. | [default to null] +**Password** | **string** | User's new password. Minimum length is 6, and maximum length is 128. | [default to null] **PasswordChangeToken** | **string** | Decrypted password change token (the token that you received from the /users/requestPasswordChange service, decrypted with your data decryption key) | [default to null] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/IdentifiersParams.md b/docs/IbanRuleIdentifiersParams.md similarity index 92% rename from docs/IdentifiersParams.md rename to docs/IbanRuleIdentifiersParams.md index abfd485..3456ef0 100644 --- a/docs/IdentifiersParams.md +++ b/docs/IbanRuleIdentifiersParams.md @@ -1,4 +1,4 @@ -# IdentifiersParams +# IbanRuleIdentifiersParams ## Properties Name | Type | Description | Notes diff --git a/docs/IbanRuleParams.md b/docs/IbanRuleParams.md index dec2944..c325e99 100644 --- a/docs/IbanRuleParams.md +++ b/docs/IbanRuleParams.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**Iban** | **string** | IBAN (case-insensitive) | [default to null] **CategoryId** | **int64** | ID of the category that this rule should assign to the matching transactions | [default to null] **Direction** | **string** | Direction for the rule. 'Income' means that the rule applies to transactions with a positive amount only, 'Spending' means it applies to transactions with a negative amount only. 'Both' means that it applies to both kind of transactions. Note that in case of 'Both', finAPI will create two individual rules (one with direction 'Income' and one with direction 'Spending'). | [default to null] -**Iban** | **string** | IBAN (case-insensitive) | [default to null] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ImportBankConnectionParams.md b/docs/ImportBankConnectionParams.md index 1ae2b56..52e9515 100644 --- a/docs/ImportBankConnectionParams.md +++ b/docs/ImportBankConnectionParams.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **BankId** | **int64** | Bank Identifier | [default to null] **Name** | **string** | Custom name for the bank connection. Maximum length is 64. If you do not want to set a name, you can leave this field unset. | [optional] [default to null] -**BankingUserId** | **string** | NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.<br><br>Online banking user ID credential. Max length: 64. NOTES:<br/>- if you import the 'demo connection', this field can be left unset;<br/> - if the user will need to enter his credentials in finAPI's web form, this field can contain any value. It will be ignored. | [optional] [default to null] -**BankingCustomerId** | **string** | NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.<br><br>Online banking customer ID credential (for most banks this field can remain unset). Max length: 64. NOTES:<br/>- if the user will need to enter his credentials in finAPI's web form, this field can contain any value. It will be ignored. | [optional] [default to null] +**BankingUserId** | **string** | NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.<br><br>Online banking user ID credential. Max length: 170. NOTES:<br/>- if you import the 'demo connection', this field can be left unset;<br/> - if the user will need to enter his credentials in finAPI's web form, this field can contain any value. It will be ignored. | [optional] [default to null] +**BankingCustomerId** | **string** | NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.<br><br>Online banking customer ID credential (for most banks this field can remain unset). Max length: 170. NOTES:<br/>- if the user will need to enter his credentials in finAPI's web form, this field can contain any value. It will be ignored. | [optional] [default to null] **BankingPin** | **string** | NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.<br><br>Online banking PIN. Max length: 170. Any symbols are allowed. NOTES:<br/>- if you import the 'demo connection', this field can be left unset;<br/> - if the user will need to enter his credentials in finAPI's web form, this field can be left unset or contain any value. It will be ignored. | [optional] [default to null] **StorePin** | **bool** | NOTE: This field is deprecated and will be removed at some point. Use 'storeSecrets' instead.<br><br>Whether to store the PIN. If the PIN is stored, it is not required to pass the PIN again when updating this bank connection or when executing orders (like money transfers). Default is false. <br/><br/>NOTES:<br/> - before you set this field to true, please regard the 'pinsAreVolatile' flag of this connection's bank;<br/> - this field is ignored in case when the user will need to use finAPI's web form. The user will be able to decide whether to store the PIN or not in the web form, depending on the 'storeSecretsAvailableInWebForm' setting (see Client Configuration). | [optional] [default to null] **Interface_** | **string** | The interface to use for connecting with the bank. | [optional] [default to null] @@ -14,7 +14,7 @@ Name | Type | Description | Notes **StoreSecrets** | **bool** | Whether to store the secret login fields. If the secret fields are stored, then updates can be triggered without the involvement of the users, as long as the credentials remain valid and the bank consent has not expired. Note that bank consent will be stored regardless of the field value. Default value is false.<br/><br/>NOTES:<br/> - this field is ignored in case when the user will need to use finAPI's web form. The user will be able to decide whether to store the secrets or not in the web form, depending on the 'storeSecretsAvailableInWebForm' setting (see Client Configuration). | [optional] [default to null] **SkipPositionsDownload** | **bool** | Whether to skip the download of transactions and securities or not. If set to true, then finAPI will download just the accounts list with the accounts' information (like account name, number, holder, etc), as well as the accounts' balances (if possible), but skip the download of transactions and securities. Default is false.<br/><br/>NOTES:<br/>&bull; If you skip the download of transactions and securities during an import or update, you can still download them on a later update (though you might not get all positions at a later point, because the date range in which the bank servers provide this data is usually limited). However, once finAPI has downloaded the transactions or securities for the first time, you will not be able to go back to skipping the download of transactions and securities! In other words: Once you make your first request with skipPositionsDownload=false for a certain bank connection, you will no longer be able to make a request with skipPositionsDownload=true for that same bank connection.<br/>&bull; If this bank connection is updated via finAPI's automatic batch update, then transactions and security positions <u>will</u> be downloaded in any case!<br/>&bull; For security accounts, skipping the downloading of the securities might result in the account's balance also not being downloaded.<br/>&bull; For Bausparen accounts, this field is ignored. finAPI will always download transactions for Bausparen accounts.<br/> | [optional] [default to null] **LoadOwnerData** | **bool** | Whether to load information about the bank connection owner(s) - see field 'owners'. Default value is 'false'.<br><br>NOTE: This feature is supported only by the WEB_SCRAPER interface. | [optional] [default to null] -**MaxDaysForDownload** | **int32** | Use this parameter if you want to limit the date range for transactions download. The value depicts the number of days that finAPI will download transactions for, starting from - and including - today. For example, if you want to download only transactions from within the past 30 days (including today), then pass the value 30. The minimum allowed value is 14, the maximum value is 3650. You may also pass the value 0 though (which is also the default value when you do not specify this parameter), in which case there will be no limit to the transactions download and finAPI will try to get all transactions that it can. Please note that when you specify the parameter there is no guarantee that finAPI will actually download transactions for the entire given date range, as the bank servers may limit the date range on their own. Also note that this parameter only applies to transactions, not to security positions; finAPI will always download all positions that it can get.<br/><br/><b>This flag is currently not guaranteed to work for all banks!</b> | [optional] [default to 0] +**MaxDaysForDownload** | **int32** | Use this parameter if you want to limit the date range for transactions download. The value depicts the number of days that finAPI will download transactions for, starting from - and including - today. For example, if you want to download only transactions from within the past 30 days (including today), then pass the value 30. The minimum allowed value is 14, the maximum value is 3650. You may also pass the value 0 though (which is also the default value when you do not specify this parameter), in which case there will be no limit to the transactions download and finAPI will try to get all transactions that it can. Please note that when you specify the parameter there is no guarantee that finAPI will actually download transactions for the entire given date range, as the bank servers may limit the date range on their own. Also note that this parameter only applies to transactions, not to security positions; finAPI will always download all positions that it can get.<br/><br/><b>Please note: If you are not limiting the maxDaysForDownload with a value smaller than 90 days, the bank is more likely to trigger a strong customer authentication request for the user.</b> | [optional] [default to 0] **AccountTypes** | **[]string** | A set of account types of finAPI account types that are considered for the import. Only accounts whose type matches with one of the given types will be imported. Note that when the bank connection does not contain any accounts of the given types, the import will fail with error code NO_ACCOUNTS_FOR_TYPE_LIST. If no values is given, then all accounts will be imported.<br/><br/><br/>Checking,<br/>Savings,<br/>CreditCard,<br/>Security,<br/>Loan,<br/>Pocket (DEPRECATED; will not be returned for any account unless this type has explicitly been set via PATCH),<br/>Membership,<br/>Bausparen<br/><br/><b>This flag is currently not guaranteed to work for all banks!</b> | [optional] [default to null] **AccountTypeIds** | **[]int64** | Whitelist of identifiers of finAPI account types that are considered for the import. Only accounts whose type matches with one of the given types will be imported. Note that when the bank connection does not contain any accounts of the given types, the import will fail with error code NO_ACCOUNTS_FOR_TYPE_LIST. If no whitelist is given, then all accounts will be imported.<br/><br/>NOTE: This field is deprecated and would be removed at some point. Please refer to the accountTypes field instead.<br/><br/><br/>1 = Checking,<br/>2 = Savings,<br/>3 = CreditCard,<br/>4 = Security,<br/>5 = Loan,<br/>6 = Pocket (DEPRECATED; will not be returned for any account unless this type has explicitly been set via PATCH),<br/>7 = Membership,<br/>8 = Bausparen<br/><br/><b>This flag is currently not guaranteed to work for all banks!</b> | [optional] [default to null] **AccountReferences** | [**[]AccountReference**](AccountReference.md) | List of accounts for which access is requested from the bank. It must only be passed if the bank interface has the DETAILED_CONSENT property set. | [optional] [default to null] diff --git a/docs/KeywordRuleIdentifiersParams.md b/docs/KeywordRuleIdentifiersParams.md new file mode 100644 index 0000000..ddd3485 --- /dev/null +++ b/docs/KeywordRuleIdentifiersParams.md @@ -0,0 +1,10 @@ +# KeywordRuleIdentifiersParams + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | **[]int64** | List of identifiers | [default to null] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/LabelsApi.md b/docs/LabelsApi.md index e095d77..83d5516 100644 --- a/docs/LabelsApi.md +++ b/docs/LabelsApi.md @@ -143,7 +143,7 @@ Name | Type | Description | Notes **ids** | [**optional.Interface of []int64**](int64.md)| A comma-separated list of label identifiers. If specified, then only labels whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. | **search** | **optional.String**| If specified, then only those labels will be contained in the result whose 'name' contains the given search string (the matching works case-insensitive). If no labels contain the search string in their name, 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 name in order for a label to get included into the result. | **page** | **optional.Int32**| Result page that you want to retrieve | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] **order** | [**optional.Interface of []string**](string.md)| Determines the order of the results. You can order the results by 'id' or 'name'. The default order for all services is 'id,asc'. Since both fields (id and name) are unique, ordering by multiple fields is pointless. The general format is: 'property[,asc|desc]', with 'asc' being the default value. | ### Return type diff --git a/docs/LoginCredentialResource.md b/docs/LoginCredentialResource.md index 5e77f15..28fbb62 100644 --- a/docs/LoginCredentialResource.md +++ b/docs/LoginCredentialResource.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Label** | **string** | Label for this login credential, as we suggest to show it to the user. | [optional] [default to null] -**Value** | **string** | Stored value for this login credential | [optional] [default to null] +**Value** | **string** | Stored value for this login credential. Please NOTE:<br/>&bull; If a PIN is stored, this will always be 'XXXXX'.<br/>&bull; If your client has no license for processing banking credentials or if this field contains a value that requires password protection then this field will always be 'XXXXX'. | [optional] [default to null] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/MandatorAdministrationApi.md b/docs/MandatorAdministrationApi.md index 216a4ab..7fb1a0c 100644 --- a/docs/MandatorAdministrationApi.md +++ b/docs/MandatorAdministrationApi.md @@ -110,7 +110,7 @@ Delete one or multiple IBAN rules that you have previously created via the 'Crea Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **body** | [**IdentifiersParams**](IdentifiersParams.md)| List of IBAN rules identifiers.The maximum number of identifiers is 100. | + **body** | [**IbanRuleIdentifiersParams**](IbanRuleIdentifiersParams.md)| List of IBAN rules identifiers.The maximum number of identifiers is 100. | ### Return type @@ -138,7 +138,7 @@ Delete one or multiple keyword rules that you have previously created via the 'C Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **body** | [**IdentifiersParams**](IdentifiersParams.md)| List of keyword rule identifiers.The maximum number of identifiers is 100. | + **body** | [**KeywordRuleIdentifiersParams**](KeywordRuleIdentifiersParams.md)| List of keyword rule identifiers.The maximum number of identifiers is 100. | ### Return type @@ -202,7 +202,7 @@ Optional parameters are passed through a pointer to a GetIbanRuleListOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page** | **optional.Int32**| Result page that you want to retrieve | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] ### Return type @@ -238,7 +238,7 @@ Optional parameters are passed through a pointer to a GetKeywordRuleListOpts str Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page** | **optional.Int32**| Result page that you want to retrieve | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] ### Return type @@ -283,10 +283,11 @@ Name | Type | Description | Notes **monthlyStatsStartDate** | **optional.String**| Minimum bound for the monthly stats (=oldest month that should be included). Must be passed in the format 'YYYY-MM'. If not specified, then the monthly stats will go back up to the first month in which the user existed (date of the user's registration). Note that this field is only regarded if 'includeMonthlyStats' = true. | **monthlyStatsEndDate** | **optional.String**| Maximum bound for the monthly stats (=latest month that should be included). Must be passed in the format 'YYYY-MM'. If not specified, then the monthly stats will go up to either the current month (for active users), or up to the month of deletion (for deleted users). Note that this field is only regarded if 'includeMonthlyStats' = true. | **minBankConnectionCountInMonthlyStats** | **optional.Int32**| A value of X means that the service will return only those users which had at least X bank connections imported at any time within the returned monthly stats set. This field is only regarded when 'includeMonthlyStats' is set to 'true'. The default value for this field is 0. | [default to 0] + **userId** | **optional.String**| The identifier of a user to search for. If specified, then only the user with the given id will be regarded. If no user can be found for the passed userId (because the user was deleted or his username was misspelled), then the result list will be empty. | **isDeleted** | **optional.Bool**| If NOT specified, then the service will regard both active and deleted users in the search. If set to 'true', then ONLY deleted users will be regarded. If set to 'false', then ONLY active users will be regarded. | **isLocked** | **optional.Bool**| If NOT specified, then the service will regard both locked and not locked users in the search. If set to 'true', then ONLY locked users will be regarded. If set to 'false', then ONLY not locked users will be regarded. | **page** | **optional.Int32**| Result page that you want to retrieve | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] **order** | [**optional.Interface of []string**](string.md)| Determines the order of the results. You can order the results by 'userId'. The default order for this service is 'userId,asc'. The general format is: 'property[,asc|desc]', with 'asc' being the default value. | ### Return type diff --git a/docs/MultiStepAuthenticationChallenge.md b/docs/MultiStepAuthenticationChallenge.md index 722d360..6b5c25e 100644 --- a/docs/MultiStepAuthenticationChallenge.md +++ b/docs/MultiStepAuthenticationChallenge.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Hash** | **string** | Hash for this multi-step authentication flow. Must be passed back to finAPI when continuing the flow. | [default to null] -**Status** | **string** | Indicates the current status of the multi-step authentication flow:<br/>&bull; CHALLENGE_RESPONSE_REQUIRED - means that the bank has sent a 'challengeMessage' which must be presented to the user. The user's answer must then be passed back to finAPI as 'challengeResponse';<br/>&bull; TWO_STEP_PROCEDURE_REQUIRED - means that the user has to select one of the 'twoStepProcedures'. The selection must then be passed back to finAPI as 'twoStepProcedureId';<br/>&bull; REDIRECT_REQUIRED - means that the bank has sent a 'redirectUrl', to which the user must be forwarded. The bank's callback must then be passed back to finAPI as 'redirectCallback'. | [default to null] +**Status** | **string** | Indicates the current status of the multi-step authentication flow:<br/><br/>TWO_STEP_PROCEDURE_REQUIRED means that the bank has requested an SCA method selection for the user. In this case, the service should be recalled with a chosen TSP-ID set to the 'twoStepProcedureId' field.<br/>When the web form flow is used, the user is forwarded to finAPI's web form to prompt for his credentials (if they are not stored in finAPI) and to select the preferred SCA method.<br/><br/>CHALLENGE_RESPONSE_REQUIRED means that the bank has requested a challenge code for the previously given TSP (SCA). This status can be completed by setting the 'challengeResponse' field.<br/>When the web form flow is used, the user should submit the challenge response for the challenge message shown by the web form.<br/><br/>REDIRECT_REQUIRED means that the user must be redirected to the bank's website, where the authentication can be finished.<br/>When the web form flow is used, the user should visit the web form, get a redirect to the bank's website, complete the authentication and will then be redirected back to the web form.<br/><br/>DECOUPLED_AUTH_REQUIRED means that the bank has asked for the decoupled authentication. In this case, the 'decoupledCallback' field must be set to true to complete the authentication.<br/><br/>DECOUPLED_AUTH_IN_PROGRESS means that the bank is waiting for the completion of the decoupled authentication by the user. Until this is done, the service should be recalled with the 'decoupledCallback' field set to ‘true’. Once the decoupled authentication is completed by the user, the service returns a successful response. | [default to null] **ChallengeMessage** | **string** | In case of status = CHALLENGE_RESPONSE_REQUIRED, this field contains a message from the bank containing instructions for the user on how to proceed with the authorization. | [optional] [default to null] **AnswerFieldLabel** | **string** | Suggestion from the bank on how you can label your input field where the user should enter his challenge response. | [optional] [default to null] **RedirectUrl** | **string** | In case of status = REDIRECT_REQUIRED, this field contains the URL to which you must direct the user. It already includes the redirect URL back to your client that you have passed when initiating the service call. | [optional] [default to null] diff --git a/docs/PaymentsApi.md b/docs/PaymentsApi.md index f42727a..480c6f8 100644 --- a/docs/PaymentsApi.md +++ b/docs/PaymentsApi.md @@ -30,7 +30,7 @@ Name | Type | Description | Notes **minAmount** | **optional.Float32**| If specified, then only those payments are regarded whose (absolute) total amount is equal or greater than the given amount will be regarded. The value must be a positive (absolute) amount. | **maxAmount** | **optional.Float32**| If specified, then only those payments are regarded whose (absolute) total amount is equal or less than the given amount will be regarded. Value must be a positive (absolute) amount. | **page** | **optional.Int32**| Result page that you want to retrieve | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] **order** | [**optional.Interface of []string**](string.md)| Determines the order of the results. You can use the following fields for ordering the response: 'id', 'amount', 'requestDate' and 'executionDate'. The default order for all services is 'id,asc'. | ### Return type diff --git a/docs/RequestSepaMoneyTransferParams.md b/docs/RequestSepaMoneyTransferParams.md index 9fcbb08..8cbdd2e 100644 --- a/docs/RequestSepaMoneyTransferParams.md +++ b/docs/RequestSepaMoneyTransferParams.md @@ -5,8 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **RecipientName** | **string** | Name of the recipient. Note: Neither finAPI nor the involved bank servers are guaranteed to validate the recipient name. Even if the recipient name does not depict the actual registered account holder of the specified recipient account, the money transfer request might still be successful. This field is optional only when you pass a clearing account as the recipient. Otherwise, this field is required. | [optional] [default to null] **RecipientIban** | **string** | IBAN of the recipient's account. This field is optional only when you pass a clearing account as the recipient. Otherwise, this field is required. | [optional] [default to null] -**RecipientBic** | **string** | BIC of the recipient's account. Note: This field is optional when you pass a clearing account as the recipient or if the bank connection of the account that you want to transfer money from supports the IBAN-Only money transfer. You can find this out via GET /bankConnections/<id>. Also note that when a BIC is given, then this BIC will be used for the money transfer request independent of whether it is required or not (unless you pass a clearing account, in which case this field will always be ignored). | [optional] [default to null] +**RecipientBic** | **string** | BIC of the recipient's account. Note: This field is optional when you pass a clearing account as the recipient or if the bank connection of the account that you want to transfer money from supports the IBAN-Only money transfer. You can find this out via GET /bankConnections/<id>. If no BIC is given, finAPI will try to recognize it using the given recipientIban value (if it's given). And then if the result value is not empty, it will be used for the money transfer request independent of whether it is required or not (unless you pass a clearing account, in which case the value will always be ignored). | [optional] [default to null] **ClearingAccountId** | **string** | Identifier of a clearing account. If this field is set, then the fields 'recipientName', 'recipientIban' and 'recipientBic' will be ignored and the recipient account will be the specified clearing account. | [optional] [default to null] +**EndToEndId** | **string** | End-To-End ID for the transfer transaction | [optional] [default to null] **Amount** | **float32** | The amount to transfer. Must be a positive decimal number with at most two decimal places (e.g. 99.99) | [default to null] **Purpose** | **string** | The purpose of the transfer transaction | [optional] [default to null] **SepaPurposeCode** | **string** | SEPA purpose code, according to ISO 20022, external codes set. | [optional] [default to null] diff --git a/docs/SecuritiesApi.md b/docs/SecuritiesApi.md index ba9a6af..e4d2782 100644 --- a/docs/SecuritiesApi.md +++ b/docs/SecuritiesApi.md @@ -31,7 +31,7 @@ Name | Type | Description | Notes **search** | **optional.String**| If specified, then only those securities will be contained in the result whose 'name', 'isin' or 'wkn' contains the given search string (the matching works case-insensitive). If no securities 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 a security to get included into the result. | **accountIds** | [**optional.Interface of []int64**](int64.md)| Comma-separated list of identifiers of accounts | **page** | **optional.Int32**| Result page that you want to retrieve. | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] **order** | [**optional.Interface of []string**](string.md)| Determines the order of the results. You can order the results by next fields: 'id', 'name', 'isin', 'wkn', 'quote', 'quantityNominal', 'marketValue' and 'entryQuote'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. 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). | ### Return type diff --git a/docs/SingleDirectDebitData.md b/docs/SingleDirectDebitData.md index e057f5e..36a2b73 100644 --- a/docs/SingleDirectDebitData.md +++ b/docs/SingleDirectDebitData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **DebitorName** | **string** | Name of the debitor. Note: Neither finAPI nor the involved bank servers are guaranteed to validate the debitor name. Even if the debitor name does not depict the actual registered account holder of the specified debitor account, the direct debit request might still be successful. | [default to null] **DebitorIban** | **string** | IBAN of the debitor's account | [default to null] -**DebitorBic** | **string** | BIC of the debitor's account. Note: This field is optional if - and only if - the bank connection of the account that you want to transfer money to supports the IBAN-Only direct debit. You can find this out via GET /bankConnections/<id>. Also note that when a BIC is given, then this BIC will be used for the direct debit request independent of whether it is required or not. | [optional] [default to null] +**DebitorBic** | **string** | BIC of the debitor's account. Note: This field is optional if - and only if - the bank connection of the account that you want to transfer money to supports the IBAN-Only direct debit. You can find this out via GET /bankConnections/<id>. If no BIC is given, finAPI will try to recognize it using the given debitorIban value (if it's given). And then if the result value is not empty, it will be used for the direct debit request independent of whether it is required or not. | [optional] [default to null] **Amount** | **float32** | The amount to transfer. Must be a positive decimal number with at most two decimal places (e.g. 99.99) | [default to null] **Purpose** | **string** | The purpose of the transfer transaction | [optional] [default to null] **SepaPurposeCode** | **string** | SEPA purpose code, according to ISO 20022, external codes set. | [optional] [default to null] diff --git a/docs/SingleMoneyTransferRecipientData.md b/docs/SingleMoneyTransferRecipientData.md index 8ffada3..82aaa9f 100644 --- a/docs/SingleMoneyTransferRecipientData.md +++ b/docs/SingleMoneyTransferRecipientData.md @@ -5,8 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **RecipientName** | **string** | Name of the recipient. Note: Neither finAPI nor the involved bank servers are guaranteed to validate the recipient name. Even if the recipient name does not depict the actual registered account holder of the specified recipient account, the money transfer request might still be successful. This field is optional only when you pass a clearing account as the recipient. Otherwise, this field is required. | [optional] [default to null] **RecipientIban** | **string** | IBAN of the recipient's account. This field is optional only when you pass a clearing account as the recipient. Otherwise, this field is required. | [optional] [default to null] -**RecipientBic** | **string** | BIC of the recipient's account. Note: This field is optional when you pass a clearing account as the recipient or if the bank connection of the account that you want to transfer money from supports the IBAN-Only money transfer. You can find this out via GET /bankConnections/<id>. Also note that when a BIC is given, then this BIC will be used for the money transfer request independent of whether it is required or not (unless you pass a clearing account, in which case this field will always be ignored). | [optional] [default to null] +**RecipientBic** | **string** | BIC of the recipient's account. Note: This field is optional when you pass a clearing account as the recipient or if the bank connection of the account that you want to transfer money from supports the IBAN-Only money transfer. You can find this out via GET /bankConnections/<id>. If no BIC is given, finAPI will try to recognize it using the given recipientIban value (if it's given). And then if the result value is not empty, it will be used for the money transfer request independent of whether it is required or not (unless you pass a clearing account, in which case the value will always be ignored). | [optional] [default to null] **ClearingAccountId** | **string** | Identifier of a clearing account. If this field is set, then the fields 'recipientName', 'recipientIban' and 'recipientBic' will be ignored and the recipient account will be the specified clearing account. | [optional] [default to null] +**EndToEndId** | **string** | End-To-End ID for the transfer transaction | [optional] [default to null] **Amount** | **float32** | The amount to transfer. Must be a positive decimal number with at most two decimal places (e.g. 99.99) | [default to null] **Purpose** | **string** | The purpose of the transfer transaction | [optional] [default to null] **SepaPurposeCode** | **string** | SEPA purpose code, according to ISO 20022, external codes set. | [optional] [default to null] diff --git a/docs/TPPCertificatesApi.md b/docs/TPPCertificatesApi.md index c2f7138..5f72378 100644 --- a/docs/TPPCertificatesApi.md +++ b/docs/TPPCertificatesApi.md @@ -85,7 +85,7 @@ Optional parameters are passed through a pointer to a GetAllCertificatesOpts str Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page** | **optional.Int32**| Result page that you want to retrieve | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] ### Return type diff --git a/docs/TPPCredentialsApi.md b/docs/TPPCredentialsApi.md index 1d80370..c0ea8db 100644 --- a/docs/TPPCredentialsApi.md +++ b/docs/TPPCredentialsApi.md @@ -117,7 +117,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **search** | **optional.String**| Returns only the TPP credentials belonging to those banks whose 'name', 'blz', or 'bic' contains the given search string (the matching works case-insensitive). Note: If the given search string consists of several terms (separated by whitespace), then ALL of these terms must apply to a bank in order for it to get included into the result. | **page** | **optional.Int32**| Result page that you want to retrieve | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] ### Return type @@ -152,11 +152,12 @@ Optional parameters are passed through a pointer to a GetAndSearchTppAuthenticat Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **ids** | [**optional.Interface of []int64**](int64.md)| A comma-separated list of TPP authentication group identifiers. If specified, then only TPP authentication groups whose identifier match any of the given identifiers will be regarded. The maximum number of identifiers is 1000. | **name** | **optional.String**| Only the tpp authentication groups with name matching the given one should appear in the result list | **bankBlz** | **optional.String**| Search by connected banks: only the banks with BLZ matching the given one should appear in the result list | **bankName** | **optional.String**| Search by connected banks: only the banks with name matching the given one should appear in the result list | **page** | **optional.Int32**| Result page that you want to retrieve | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] ### Return type diff --git a/docs/TppCertificateParams.md b/docs/TppCertificateParams.md index 6fcc8b3..3c46ce0 100644 --- a/docs/TppCertificateParams.md +++ b/docs/TppCertificateParams.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Type_** | **string** | A type of certificate submitted | [default to null] **PublicKey** | **string** | A certificate (public key) | [default to null] -**PrivateKey** | **string** | A private key in PKCS #8 format. PKCS #8 private keys are typically exchanged in the PEM base64-encoded format (https://support.quovadisglobal.com/kb/a37/what-is-pem-format.aspx)</br></br>NOTE: The certificate should have one of the following headers:</br>- '-----BEGIN PRIVATE KEY-----'</br>- '-----BEGIN ENCRYPTED PRIVATE KEY-----'<br>Any other header denotes that the private key is NOT in PKCS #8 format! | [default to null] +**PrivateKey** | **string** | A private key in PKCS #8 or PKCS #1 format. PKCS #1/#8 private keys are typically exchanged in the PEM base64-encoded format (https://support.quovadisglobal.com/kb/a37/what-is-pem-format.aspx)</br></br>NOTE: The certificate should have one of the following headers:</br>- '-----BEGIN RSA PRIVATE KEY-----'<br>- '-----BEGIN PRIVATE KEY-----'</br>- '-----BEGIN ENCRYPTED PRIVATE KEY-----'<br>Any other header denotes that the private key is neither in PKCS #8 nor in PKCS #1 formats! | [default to null] **Passphrase** | **string** | Optional passphrase for the private key | [optional] [default to null] -**Label** | **string** | Optional label to certificate to identify in the list of certificates | [default to null] +**Label** | **string** | A label for certificate to identify in the list of certificates | [default to null] **ValidFromDate** | **string** | Start day of the certificate's validity, in the format 'YYYY-MM-DD'. Default is the passed certificate validFrom date | [optional] [default to null] **ValidUntilDate** | **string** | Expiration day of the certificate's validity, in the format 'YYYY-MM-DD'. Default is the passed certificate validUntil date | [optional] [default to null] diff --git a/docs/TppCredentialsParams.md b/docs/TppCredentialsParams.md index b925f29..95f6e5d 100644 --- a/docs/TppCredentialsParams.md +++ b/docs/TppCredentialsParams.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TppAuthenticationGroupId** | **int64** | The TPP Authentication Group Id for which the credentials can be used | [default to null] **Label** | **string** | Optional label to credentials | [default to null] -**TppClientId** | **string** | ID of the TPP accessing the ASPSP API, as provided by the ASPSP as the result of registration | [default to null] -**TppClientSecret** | **string** | Secret of the TPP accessing the ASPSP API, as provided by the ASPSP as the result of registration | [default to null] +**TppClientId** | **string** | ID of the TPP accessing the ASPSP API, as provided by the ASPSP as the result of registration | [optional] [default to null] +**TppClientSecret** | **string** | Secret of the TPP accessing the ASPSP API, as provided by the ASPSP as the result of registration | [optional] [default to null] **TppApiKey** | **string** | API Key provided by ASPSP as the result of registration | [optional] [default to null] **ValidFromDate** | **string** | Credentials \"valid from\" date in the format 'YYYY-MM-DD'. Default is today's date | [optional] [default to null] **ValidUntilDate** | **string** | Credentials \"valid until\" date in the format 'YYYY-MM-DD'. Default is null which means \"indefinite\" (no limit) | [optional] [default to null] diff --git a/docs/TransactionsApi.md b/docs/TransactionsApi.md index 7cf4f16..1161bd0 100644 --- a/docs/TransactionsApi.md +++ b/docs/TransactionsApi.md @@ -209,7 +209,7 @@ Name | Type | Description | Notes **minImportDate** | **optional.String**| Lower bound for a transaction's import date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only transactions whose 'importDate' is equal to or later than the given date will be regarded. | **maxImportDate** | **optional.String**| Upper bound for a transaction's import date, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only transactions whose 'importDate' is equal to or earlier than the given date will be regarded. | **page** | **optional.Int32**| Result page that you want to retrieve. | [default to 1] - **perPage** | **optional.Int32**| 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. | [default to 20] + **perPage** | **optional.Int32**| Maximum number of records per page. By default it's 20. 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. | [default to 20] **order** | [**optional.Interface of []string**](string.md)| Determines the order of the results. You can use the following fields for ordering the response: 'id', 'parentId', 'accountId', 'valueDate', 'bankBookingDate', 'finapiBookingDate', 'amount', 'purpose', 'counterpartName', 'counterpartAccountNumber', 'counterpartIban', 'counterpartBlz', 'counterpartBic', 'type', 'primanota', 'category.id', 'category.name', 'isPotentialDuplicate', 'isNew' and 'importDate'. The default order for all services is 'id,asc'. You can also order by multiple properties. In that case the order of the parameters passed is important. Example: '/transactions?order=finapiBookingDate,desc&order=counterpartName' will return the latest transactions first. If there are more transactions on the same day, then these transactions are ordered by the counterpart name (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). | ### Return type diff --git a/docs/UserCreateParams.md b/docs/UserCreateParams.md index 1b39782..24d7640 100644 --- a/docs/UserCreateParams.md +++ b/docs/UserCreateParams.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **string** | User's identifier. Max length is 36 symbols. Only the following symbols are allowed: 0-9, A-Z, a-z, -, _, ., +, @. If not specified, then a unique random value will be generated. | [optional] [default to null] -**Password** | **string** | User's password. Minimum length is 6, and maximum length is 36. If not specified, then a unique random value will be generated. | [optional] [default to null] +**Password** | **string** | User's password. Minimum length is 6, and maximum length is 128. If not specified, then a unique random value will be generated. | [optional] [default to null] **Email** | **string** | User's email address. Maximum length is 320. | [optional] [default to null] **Phone** | **string** | User's phone number. Maximum length is 50. | [optional] [default to null] **IsAutoUpdateEnabled** | **bool** | Whether the user's bank connections will get updated in the course of finAPI's automatic batch update. Note that the automatic batch update will only update bank connections where all of the following applies:<br><br> - the PIN is stored in finAPI for the bank connection<br> - the user has accepted the latest Terms and Conditions (this only applies to users whose mandator has PISP license or doesn't have a license at all)<br> - the user has allowed finAPI to use his old stored credentials (this only applies to users which had stored credentials before introducing a web form feature and whose mandator has PISP license or doesn't have a license at all)<br> - the previous update using the stored credentials did not fail due to the credentials being incorrect (or there was no previous update with the stored credentials)<br> - the bank that the bank connection relates to is included in the automatic batch update (please contact your Sys-Admin for details about the batch update configuration)<br><br>Also note that the automatic batch update must generally be enabled for your client in order for this field to have any effect.<br/><br/>WARNING: The automatic update will always download transactions and security positions for any account that it updates! This means that the user will no longer be able to download just the balances for his accounts once the automatic update has run (The 'skipPositionsDownload' flag in the bankConnections/update service can no longer be set to true).<br/><br/>If not specified, then the automatic update will be disabled by default (false). | [optional] [default to null] diff --git a/model/model_access_token.go b/model/model_access_token.go index 771b342..9d5e018 100644 --- a/model/model_access_token.go +++ b/model/model_access_token.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -17,8 +17,8 @@ type AccessToken struct { Scope string `json:"scope"` // Refresh token. Only set in case of grant_type='password'. Token has a length of up to 128 characters. RefreshToken string `json:"refresh_token,omitempty"` - // Access token. Token has a length of up to 128 characters. - AccessToken string `json:"access_token"` // Expiration time in seconds. A value of 0 means that the token never expires (unless it is explicitly invalidated, e.g. by revocation, or when a user gets locked). ExpiresIn int32 `json:"expires_in"` + // Access token. Token has a length of up to 128 characters. + AccessToken string `json:"access_token"` } diff --git a/model/model_account.go b/model/model_account.go index 8f6e8ee..9451106 100644 --- a/model/model_account.go +++ b/model/model_account.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_account_interface.go b/model/model_account_interface.go index 9bf73e5..1e98d41 100644 --- a/model/model_account_interface.go +++ b/model/model_account_interface.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_account_list.go b/model/model_account_list.go index a39958c..f2a9889 100644 --- a/model/model_account_list.go +++ b/model/model_account_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_account_params.go b/model/model_account_params.go index 90a5c35..afcdb66 100644 --- a/model/model_account_params.go +++ b/model/model_account_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_account_reference.go b/model/model_account_reference.go index 0655251..9fd31fc 100644 --- a/model/model_account_reference.go +++ b/model/model_account_reference.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_bad_credentials_error.go b/model/model_bad_credentials_error.go index cca001a..ff200bf 100644 --- a/model/model_bad_credentials_error.go +++ b/model/model_bad_credentials_error.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_bank.go b/model/model_bank.go index 29de986..90c06f5 100644 --- a/model/model_bank.go +++ b/model/model_bank.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -27,13 +27,13 @@ type Bank struct { Location string `json:"location,omitempty"` // City that this bank is located in. Note that this field may not be set for some banks. City string `json:"city,omitempty"` - // Whether this bank is supported by finAPI, i.e. whether you can import/update a bank connection of this bank.

NOTE: This field is deprecated and will be removed at some point. Please refer to field 'interfaces' instead. + // THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Please refer to field 'interfaces' instead.

Whether this bank is supported by finAPI, i.e. whether you can import/update a bank connection of this bank. IsSupported bool `json:"isSupported"` // If true, then this bank does not depict a real bank, but rather a testing endpoint provided by a bank or by finAPI. You probably want to regard these banks only during the development of your application, but not in production. You can filter out these banks in production by making sure that the 'isTestBank' parameter is always set to 'false' whenever your application is calling the 'Get and search all banks' service. IsTestBank bool `json:"isTestBank"` // Popularity of this bank with your users (mandator-wide, i.e. across all of your clients). The value equals the number of bank connections that are currently imported for this bank across all of your users (which means it is a constantly adjusting value). You can use this field for statistical evaluation, and also for ordering bank search results (see service 'Get and search all banks'). Popularity int32 `json:"popularity"` - // The health status of this bank. This is a value between 0 and 100, depicting the percentage of successful communication attempts with this bank during the latest couple of bank connection imports or updates (across the entire finAPI system). Note that 'successful' 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. + // THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'health' in the 'interfaces' instead.

The health status of this bank. This is a value between 0 and 100, depicting the percentage of successful communication attempts with this bank during the latest couple of bank connection imports or updates (across the entire finAPI system). Note that 'successful' 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. Health int32 `json:"health"` // THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'loginCredentials' in the 'interfaces' instead.

Label for the user ID login field, as it is called on the bank's website (e.g. \"Nutzerkennung\"). If this field is set (i.e. not null) then you should prompt your users to enter the required data in a text field which you can label with this field's value. LoginFieldUserId string `json:"loginFieldUserId,omitempty"` @@ -49,8 +49,8 @@ type Bank struct { SupportedDataSources []string `json:"supportedDataSources"` // Set of interfaces that finAPI can use to connect to the bank. Note that this set will be empty for non-supported banks. Note also that the WEB_SCRAPER interface might be disabled for your client (see GET /clientConfiguration). When this is the case, then finAPI will not use the web scraper for data download, and if the web scraper is the only supported interface of this bank, then finAPI will not allow to download any data for this bank at all (for details, see POST /bankConnections/import and POST /bankConnections/update). Interfaces []BankInterface `json:"interfaces,omitempty"` - // Time of the last communication attempt with this bank during a bank connection import or update (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). + // THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'lastCommunicationAttempt' in the 'interfaces' instead.

Time of the last communication attempt with this bank during a bank connection import or update (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). LastCommunicationAttempt string `json:"lastCommunicationAttempt,omitempty"` - // Time of the last successful communication with this bank during a bank connection import or update (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). + // THIS FIELD IS DEPRECATED AND WILL BE REMOVED. Refer to the 'lastSuccessfulCommunication' in the 'interfaces' instead.

Time of the last successful communication with this bank during a bank connection import or update (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). LastSuccessfulCommunication string `json:"lastSuccessfulCommunication,omitempty"` } diff --git a/model/model_bank_connection.go b/model/model_bank_connection.go index 8885245..4ccebbd 100644 --- a/model/model_bank_connection.go +++ b/model/model_bank_connection.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -39,7 +39,7 @@ type BankConnection struct { IbanOnlyDirectDebitSupported bool `json:"ibanOnlyDirectDebitSupported"` // NOTE: This field is deprecated and will be removed at some point. Please refer to the account capabilities instead.

Whether this bank connection supports submitting collective money transfers. This field is re-evaluated each time this bank connection is updated.
See also: /accounts/requestSepaMoneyTransfer CollectiveMoneyTransferSupported bool `json:"collectiveMoneyTransferSupported"` - // NOTE: This field is deprecated and will be removed at some point. Please refer to corresponding field in 'interfaces' instead.

The default two-step-procedure. Must match one of the available 'procedureId's from the 'twoStepProcedures' list. When this field is set, you can execute two-step-procedures (accounts/requestSepaMoneyTransfer or /requestSepaDirectDebit) without having to explicitly set a procedure. finAPI will use the default procedure in such cases. Note that the list of available procedures of a bank connection may change as a result of an update of the connection, and if this field references a procedure that is no longer available after an update, finAPI will automatically clear the default procedure (set it to null).s + // NOTE: This field is deprecated and will be removed at some point. Please refer to corresponding field in 'interfaces' instead.

The default two-step-procedure. Must match one of the available 'procedureId's from the 'twoStepProcedures' list. When this field is set, then finAPI will automatically try to select the procedure wherever applicable. Note that the list of available procedures of a bank connection may change as a result of an update of the connection, and if this field references a procedure that is no longer available after an update, finAPI will automatically clear the default procedure (set it to null). DefaultTwoStepProcedureId string `json:"defaultTwoStepProcedureId,omitempty"` // NOTE: This field is deprecated and will be removed at some point. Please refer to corresponding field in 'interfaces' instead.

Available two-step-procedures for this bank connection, used for submitting a money transfer or direct debit request (see /accounts/requestSepaMoneyTransfer or /requestSepaDirectDebit). The available two-step-procedures are re-evaluated each time this bank connection is updated (/bankConnections/update). This means that this list may change as a result of an update. TwoStepProcedures []TwoStepProcedure `json:"twoStepProcedures,omitempty"` @@ -51,6 +51,6 @@ type BankConnection struct { Owners []BankConnectionOwner `json:"owners,omitempty"` // Bank that this connection belongs to Bank *Bank `json:"bank"` - // This field indicates whether the last communication with the bank failed with an error that requires the user's attention. If 'furtherLoginNotRecommended' is true, finAPI will stop auto updates of this bank connection to mitigate the risk of the user's bank account getting locked by the bank. Every communication with the bank (via updates, money_transfers, direct debits. etc.) can change the value of this flag. If this field is true, we recommend the user to check his credentials and try a manual update of the bank connection. If the update is successful, the 'furtherLoginNotRecommended' field will be set to false and the bank connection will be reincluded in the next batch update process. A manual update of the bank connection with incorrect credentials will set this field to true and lead to the exclusion of the bank connection from the following batch updates. + // This field indicates whether the last communication with the bank failed with an error that requires the user's attention or multi-step authentication error. If 'furtherLoginNotRecommended' is true, finAPI will stop auto updates of this bank connection to mitigate the risk of the user's bank account getting locked by the bank. Every communication with the bank (via updates, money_transfers, direct debits. etc.) can change the value of this flag. If this field is true, we recommend the user to check his credentials and try a manual update of the bank connection. If the update is successful without any multi-step authentication error, the 'furtherLoginNotRecommended' field will be set to false and the bank connection will be reincluded in the next batch update process. A manual update of the bank connection with incorrect credentials or if multi-step authentication error happens will set this field to true and lead to the exclusion of the bank connection from the following batch updates. FurtherLoginNotRecommended bool `json:"furtherLoginNotRecommended"` } diff --git a/model/model_bank_connection_interface.go b/model/model_bank_connection_interface.go index c5e21ac..f065bf1 100644 --- a/model/model_bank_connection_interface.go +++ b/model/model_bank_connection_interface.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_bank_connection_list.go b/model/model_bank_connection_list.go index 64cf8c5..5d60845 100644 --- a/model/model_bank_connection_list.go +++ b/model/model_bank_connection_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_bank_connection_owner.go b/model/model_bank_connection_owner.go index fc420dc..b7d5bfe 100644 --- a/model/model_bank_connection_owner.go +++ b/model/model_bank_connection_owner.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_bank_consent.go b/model/model_bank_consent.go index 9b82364..f16b0f7 100644 --- a/model/model_bank_consent.go +++ b/model/model_bank_consent.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_bank_interface.go b/model/model_bank_interface.go index 7c0c071..60f0043 100644 --- a/model/model_bank_interface.go +++ b/model/model_bank_interface.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -17,8 +17,14 @@ type BankInterface struct { TppAuthenticationGroup *TppAuthenticationGroup `json:"tppAuthenticationGroup,omitempty"` // Login credentials fields which should be shown to the user. LoginCredentials []BankInterfaceLoginField `json:"loginCredentials"` - // Set of interface properties/specifics. Possible values:

• REDIRECT_APPROACH - 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.

• DECOUPLED_APPROACH - means that the interface uses a decoupled approach when authorizing the user.

• DETAILED_CONSENT - 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.

Note that this set can be empty, if the interface does not have any specific properties. + // Set of interface properties/specifics. Possible values:

• REDIRECT_APPROACH - 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:
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>?
• DECOUPLED_APPROACH - means that the interface uses a decoupled approach when authorizing the user.

• DETAILED_CONSENT - 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.

Note that this set can be empty, if the interface does not have any specific properties. Properties []string `json:"properties,omitempty"` // Login hint. Contains a German message for the user that explains what kind of credentials are expected.

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.

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. LoginHint string `json:"loginHint,omitempty"` + // 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 latest couple of bank connection imports or updates (across the entire finAPI system). Note that 'successful' 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. + Health int32 `json:"health"` + // Time of the last communication attempt with this interface during an import, update or connect interface (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). + LastCommunicationAttempt string `json:"lastCommunicationAttempt,omitempty"` + // Time of the last successful communication with this interface during an import, update or connect interface (across the entire finAPI system). The value is returned in the format 'YYYY-MM-DD HH:MM:SS.SSS' (german time). + LastSuccessfulCommunication string `json:"lastSuccessfulCommunication,omitempty"` } diff --git a/model/model_bank_interface_login_field.go b/model/model_bank_interface_login_field.go index 36c6667..6af2658 100644 --- a/model/model_bank_interface_login_field.go +++ b/model/model_bank_interface_login_field.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_bank_list.go b/model/model_bank_list.go index a079dd4..ec06c38 100644 --- a/model/model_bank_list.go +++ b/model/model_bank_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_cash_flow.go b/model/model_cash_flow.go index baeb8ef..dee530c 100644 --- a/model/model_cash_flow.go +++ b/model/model_cash_flow.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_cash_flow_list.go b/model/model_cash_flow_list.go index ea52843..163b6df 100644 --- a/model/model_cash_flow_list.go +++ b/model/model_cash_flow_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_categorization_check_result.go b/model/model_categorization_check_result.go index dacae8e..3f79d58 100644 --- a/model/model_categorization_check_result.go +++ b/model/model_categorization_check_result.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_categorization_check_results.go b/model/model_categorization_check_results.go index f78eea9..a191823 100644 --- a/model/model_categorization_check_results.go +++ b/model/model_categorization_check_results.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_category.go b/model/model_category.go index ddfd3d2..427e089 100644 --- a/model/model_category.go +++ b/model/model_category.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_category_list.go b/model/model_category_list.go index c0a25ce..b878c53 100644 --- a/model/model_category_list.go +++ b/model/model_category_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_category_params.go b/model/model_category_params.go index 9312c80..85931d2 100644 --- a/model/model_category_params.go +++ b/model/model_category_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_change_client_credentials_params.go b/model/model_change_client_credentials_params.go index cc956b0..672f562 100644 --- a/model/model_change_client_credentials_params.go +++ b/model/model_change_client_credentials_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_check_categorization_data.go b/model/model_check_categorization_data.go index 792ab1c..a616064 100644 --- a/model/model_check_categorization_data.go +++ b/model/model_check_categorization_data.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_check_categorization_transaction_data.go b/model/model_check_categorization_transaction_data.go index 02ffd5c..dc76574 100644 --- a/model/model_check_categorization_transaction_data.go +++ b/model/model_check_categorization_transaction_data.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_clearing_account_data.go b/model/model_clearing_account_data.go index 784d9e9..fb09c6b 100644 --- a/model/model_clearing_account_data.go +++ b/model/model_clearing_account_data.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_client_configuration.go b/model/model_client_configuration.go index a158d2e..c468ab9 100644 --- a/model/model_client_configuration.go +++ b/model/model_client_configuration.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -31,7 +31,7 @@ type ClientConfiguration struct { IsMandatorAdmin bool `json:"isMandatorAdmin"` // Whether finAPI is allowed to use the WEB_SCRAPER interface for data download. If this field is set to 'true', then finAPI might download data from the online banking websites of banks (either in addition to other interfaces, or as the sole data source for the download). If this field is set to 'false', then finAPI will not use any web scrapers. For banks where no other interface except WEB_SCRAPER is available, finAPI will not allow any data download at all if web scraping is disabled for your client. Please contact your Sys-Admin if you want to change this setting. IsWebScrapingEnabled bool `json:"isWebScrapingEnabled"` - // Whether this client is allowed to access XS2A services. + // NOTE: This field is deprecated and will be removed at some point.

Whether this client is allowed to access XS2A services. IsXs2aEnabled bool `json:"isXs2aEnabled"` // List of bank groups that are available to this client. A bank group is a collection of all banks that are located in a certain country, and is defined by the country's ISO 3166 ALPHA-2 code (see also field 'location' of Bank resource). If you want to extend or limit the available bank groups for your client, please contact your Sys-Admin.

Note: There is no bank group for international institutes (i.e. institutes that are not bound to any specific country). Instead, those institutes are always available. If this list is empty, it means that ONLY international institutes are available. AvailableBankGroups []string `json:"availableBankGroups"` @@ -41,6 +41,10 @@ type ClientConfiguration struct { FinTSProductRegistrationNumber string `json:"finTSProductRegistrationNumber,omitempty"` // Whether finAPI's web form will provide a checkbox for the user allowing him to choose whether to store login secrets (like a PIN) in finAPI. If this field is set to false, then the user won't have an option to store this data. StoreSecretsAvailableInWebForm bool `json:"storeSecretsAvailableInWebForm"` + // Default value for the subject element of support emails. + SupportSubjectDefault string `json:"supportSubjectDefault,omitempty"` + // Email address to sent support requests to from the web form. + SupportEmail string `json:"supportEmail,omitempty"` // Whether finAPI's web form will provide a checkbox for the user allowing him to choose whether to store his banking PIN in finAPI. If this field is set to false, then the user won't have an option to store his PIN.

NOTE: This field is deprecated and will be removed at some point. Refer to field 'storeSecretsAvailableInWebForm' instead. PinStorageAvailableInWebForm bool `json:"pinStorageAvailableInWebForm"` // Whether this client is allowed to do payments diff --git a/model/model_client_configuration_params.go b/model/model_client_configuration_params.go index a24fc09..aef2915 100644 --- a/model/model_client_configuration_params.go +++ b/model/model_client_configuration_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -29,4 +29,8 @@ type ClientConfigurationParams struct { ApplicationName string `json:"applicationName,omitempty"` // The FinTS product registration number. Please follow this link to apply for a registration number. Only customers who have an AISP or PISP license must define their FinTS product registration number. Customers who are relying on the finAPI web form will be assigned to finAPI's FinTS product registration number automatically and do not have to register themselves. During a batch update, finAPI is using the FinTS product registration number of the client, that was used to create the user. If you have previously set a FinTS product registration number and now want to clear it, you can pass an empty string (\"\"). Only hexa decimal characters in capital case with a maximum length of 25 characters are allowed. E.g. 'ABCDEF1234567890ABCDEF123' FinTSProductRegistrationNumber string `json:"finTSProductRegistrationNumber,omitempty"` + // Default value for the subject element of support emails. Maximum length is 100. Pass an empty string ('') if you want to clear the current subject default value. + SupportSubjectDefault string `json:"supportSubjectDefault,omitempty"` + // Email address to sent support requests to from the web form. Maximum length is 320. Pass an empty string ('') if you want to clear the current email address. + SupportEmail string `json:"supportEmail,omitempty"` } diff --git a/model/model_connect_interface_params.go b/model/model_connect_interface_params.go index 55a12e3..31b2345 100644 --- a/model/model_connect_interface_params.go +++ b/model/model_connect_interface_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_daily_balance.go b/model/model_daily_balance.go index ccef422..6cf4882 100644 --- a/model/model_daily_balance.go +++ b/model/model_daily_balance.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_daily_balance_list.go b/model/model_daily_balance_list.go index 3110998..24ee5fe 100644 --- a/model/model_daily_balance_list.go +++ b/model/model_daily_balance_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_direct_debit_ordering_response.go b/model/model_direct_debit_ordering_response.go index 4c4f085..17ba2da 100644 --- a/model/model_direct_debit_ordering_response.go +++ b/model/model_direct_debit_ordering_response.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_edit_bank_connection_params.go b/model/model_edit_bank_connection_params.go index b2c64c0..02508db 100644 --- a/model/model_edit_bank_connection_params.go +++ b/model/model_edit_bank_connection_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -13,9 +13,9 @@ package finapi type EditBankConnectionParams struct { // New name for the bank connection. Maximum length is 64. If you do not want to change the current name let this field remain unset. If you want to clear the current name, set the field's value to an empty string (\"\"). Name string `json:"name,omitempty"` - // NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.

New online banking user ID. If you do not want to change the current user ID let this field remain unset. In case you need to use finAPI's web form to let the user update the field, just set the field to any value, so that the service recognizes that you wish to use the web form flow. Note that you cannot clear the current user ID, i.e. a bank connection must always have a user ID (except for when it is a 'demo connection'). Max length: 64. + // NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.

New online banking user ID. If you do not want to change the current user ID let this field remain unset. In case you need to use finAPI's web form to let the user update the field, just set the field to any value, so that the service recognizes that you wish to use the web form flow. Note that you cannot clear the current user ID, i.e. a bank connection must always have a user ID (except for when it is a 'demo connection'). Max length: 170. BankingUserId string `json:"bankingUserId,omitempty"` - // NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.

New online banking customer ID. If you do not want to change the current customer ID let this field remain unset. In case you need to use finAPI's web form to let the user update the field, just set the field to non-empty value, so that the service recognizes that you wish to use the web form flow. If you want to clear the current customer ID, set the field's value to an empty string (\"\"). Max length: 64. + // NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.

New online banking customer ID. If you do not want to change the current customer ID let this field remain unset. In case you need to use finAPI's web form to let the user update the field, just set the field to non-empty value, so that the service recognizes that you wish to use the web form flow. If you want to clear the current customer ID, set the field's value to an empty string (\"\"). Max length: 170. BankingCustomerId string `json:"bankingCustomerId,omitempty"` // NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.

New online banking PIN. If you do not want to change the current PIN let this field remain unset. In case you need to use finAPI's web form to let the user update the field, just set the field to non-empty value, so that the service recognizes that you wish to use the web form flow. If you want to clear the current PIN, set the field's value to an empty string (\"\").

Any symbols are allowed. Max length: 170. BankingPin string `json:"bankingPin,omitempty"` diff --git a/model/model_edit_category_params.go b/model/model_edit_category_params.go index c40f55d..b629774 100644 --- a/model/model_edit_category_params.go +++ b/model/model_edit_category_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_edit_tpp_credential_params.go b/model/model_edit_tpp_credential_params.go index 1211a23..3ba1c0c 100644 --- a/model/model_edit_tpp_credential_params.go +++ b/model/model_edit_tpp_credential_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_error_details.go b/model/model_error_details.go index e5072b7..2240278 100644 --- a/model/model_error_details.go +++ b/model/model_error_details.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -15,7 +15,7 @@ type ErrorDetails struct { Message string `json:"message,omitempty"` // Error code. See the documentation of the individual services for details about what values may be returned. Code string `json:"code"` - // Error type. BUSINESS errors depict German error messages for the user, e.g. from a bank server. TECHNICAL errors depict internal errors. + // Error type. BUSINESS errors depict error messages in the language of the bank (or the preferred language) for the user, e.g. from a bank server. TECHNICAL errors are meant to be read by developers and depict internal errors. Type_ string `json:"type"` // This field is set when a multi-step authentication is required, i.e. when you need to repeat the original service call and provide additional data. The field contains information about what additional data is required. MultiStepAuthentication *MultiStepAuthenticationChallenge `json:"multiStepAuthentication,omitempty"` diff --git a/model/model_error_message.go b/model/model_error_message.go index 41e69b3..395e60c 100644 --- a/model/model_error_message.go +++ b/model/model_error_message.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_execute_password_change_params.go b/model/model_execute_password_change_params.go index c4afda4..4ad7368 100644 --- a/model/model_execute_password_change_params.go +++ b/model/model_execute_password_change_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -13,7 +13,7 @@ package finapi type ExecutePasswordChangeParams struct { // User identifier UserId string `json:"userId"` - // User's new password. Minimum length is 6, and maximum length is 36. + // User's new password. Minimum length is 6, and maximum length is 128. Password string `json:"password"` // Decrypted password change token (the token that you received from the /users/requestPasswordChange service, decrypted with your data decryption key) PasswordChangeToken string `json:"passwordChangeToken"` diff --git a/model/model_execute_sepa_direct_debit_params.go b/model/model_execute_sepa_direct_debit_params.go index 173e1aa..3278c3b 100644 --- a/model/model_execute_sepa_direct_debit_params.go +++ b/model/model_execute_sepa_direct_debit_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_execute_sepa_money_transfer_params.go b/model/model_execute_sepa_money_transfer_params.go index 5c93b09..af258f1 100644 --- a/model/model_execute_sepa_money_transfer_params.go +++ b/model/model_execute_sepa_money_transfer_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_iban_rule.go b/model/model_iban_rule.go index bface34..6fc97af 100644 --- a/model/model_iban_rule.go +++ b/model/model_iban_rule.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_identifiers_params.go b/model/model_iban_rule_identifiers_params.go similarity index 79% rename from model/model_identifiers_params.go rename to model/model_iban_rule_identifiers_params.go index 6d28eb4..316bb45 100644 --- a/model/model_identifiers_params.go +++ b/model/model_iban_rule_identifiers_params.go @@ -3,14 +3,14 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ package finapi // Identifiers params -type IdentifiersParams struct { +type IbanRuleIdentifiersParams struct { // List of identifiers Ids []int64 `json:"ids"` } diff --git a/model/model_iban_rule_list.go b/model/model_iban_rule_list.go index b72ed15..3ab0611 100644 --- a/model/model_iban_rule_list.go +++ b/model/model_iban_rule_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_iban_rule_params.go b/model/model_iban_rule_params.go index 500264c..0dcfdc9 100644 --- a/model/model_iban_rule_params.go +++ b/model/model_iban_rule_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -11,10 +11,10 @@ package finapi // Parameters of IBAN rule type IbanRuleParams struct { + // IBAN (case-insensitive) + Iban string `json:"iban"` // ID of the category that this rule should assign to the matching transactions CategoryId int64 `json:"categoryId"` // Direction for the rule. 'Income' means that the rule applies to transactions with a positive amount only, 'Spending' means it applies to transactions with a negative amount only. 'Both' means that it applies to both kind of transactions. Note that in case of 'Both', finAPI will create two individual rules (one with direction 'Income' and one with direction 'Spending'). Direction string `json:"direction"` - // IBAN (case-insensitive) - Iban string `json:"iban"` } diff --git a/model/model_iban_rules_params.go b/model/model_iban_rules_params.go index a24e065..19901a0 100644 --- a/model/model_iban_rules_params.go +++ b/model/model_iban_rules_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_identifier_list.go b/model/model_identifier_list.go index 52bc603..f54e3e8 100644 --- a/model/model_identifier_list.go +++ b/model/model_identifier_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_import_bank_connection_params.go b/model/model_import_bank_connection_params.go index 1590d7f..b6889e5 100644 --- a/model/model_import_bank_connection_params.go +++ b/model/model_import_bank_connection_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -15,9 +15,9 @@ type ImportBankConnectionParams struct { BankId int64 `json:"bankId"` // Custom name for the bank connection. Maximum length is 64. If you do not want to set a name, you can leave this field unset. Name string `json:"name,omitempty"` - // NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.

Online banking user ID credential. Max length: 64. NOTES:
- if you import the 'demo connection', this field can be left unset;
- if the user will need to enter his credentials in finAPI's web form, this field can contain any value. It will be ignored. + // NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.

Online banking user ID credential. Max length: 170. NOTES:
- if you import the 'demo connection', this field can be left unset;
- if the user will need to enter his credentials in finAPI's web form, this field can contain any value. It will be ignored. BankingUserId string `json:"bankingUserId,omitempty"` - // NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.

Online banking customer ID credential (for most banks this field can remain unset). Max length: 64. NOTES:
- if the user will need to enter his credentials in finAPI's web form, this field can contain any value. It will be ignored. + // NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.

Online banking customer ID credential (for most banks this field can remain unset). Max length: 170. NOTES:
- if the user will need to enter his credentials in finAPI's web form, this field can contain any value. It will be ignored. BankingCustomerId string `json:"bankingCustomerId,omitempty"` // NOTE: This field is deprecated and will be removed at some point. Use 'loginCredentials' + 'interface' instead. If any of those two fields is used, then the value of this field will be ignored.

Online banking PIN. Max length: 170. Any symbols are allowed. NOTES:
- if you import the 'demo connection', this field can be left unset;
- if the user will need to enter his credentials in finAPI's web form, this field can be left unset or contain any value. It will be ignored. BankingPin string `json:"bankingPin,omitempty"` @@ -33,7 +33,7 @@ type ImportBankConnectionParams struct { SkipPositionsDownload bool `json:"skipPositionsDownload,omitempty"` // Whether to load information about the bank connection owner(s) - see field 'owners'. Default value is 'false'.

NOTE: This feature is supported only by the WEB_SCRAPER interface. LoadOwnerData bool `json:"loadOwnerData,omitempty"` - // Use this parameter if you want to limit the date range for transactions download. The value depicts the number of days that finAPI will download transactions for, starting from - and including - today. For example, if you want to download only transactions from within the past 30 days (including today), then pass the value 30. The minimum allowed value is 14, the maximum value is 3650. You may also pass the value 0 though (which is also the default value when you do not specify this parameter), in which case there will be no limit to the transactions download and finAPI will try to get all transactions that it can. Please note that when you specify the parameter there is no guarantee that finAPI will actually download transactions for the entire given date range, as the bank servers may limit the date range on their own. Also note that this parameter only applies to transactions, not to security positions; finAPI will always download all positions that it can get.

This flag is currently not guaranteed to work for all banks! + // Use this parameter if you want to limit the date range for transactions download. The value depicts the number of days that finAPI will download transactions for, starting from - and including - today. For example, if you want to download only transactions from within the past 30 days (including today), then pass the value 30. The minimum allowed value is 14, the maximum value is 3650. You may also pass the value 0 though (which is also the default value when you do not specify this parameter), in which case there will be no limit to the transactions download and finAPI will try to get all transactions that it can. Please note that when you specify the parameter there is no guarantee that finAPI will actually download transactions for the entire given date range, as the bank servers may limit the date range on their own. Also note that this parameter only applies to transactions, not to security positions; finAPI will always download all positions that it can get.

Please note: If you are not limiting the maxDaysForDownload with a value smaller than 90 days, the bank is more likely to trigger a strong customer authentication request for the user. MaxDaysForDownload int32 `json:"maxDaysForDownload,omitempty"` // A set of account types of finAPI account types that are considered for the import. Only accounts whose type matches with one of the given types will be imported. Note that when the bank connection does not contain any accounts of the given types, the import will fail with error code NO_ACCOUNTS_FOR_TYPE_LIST. If no values is given, then all accounts will be imported.


Checking,
Savings,
CreditCard,
Security,
Loan,
Pocket (DEPRECATED; will not be returned for any account unless this type has explicitly been set via PATCH),
Membership,
Bausparen

This flag is currently not guaranteed to work for all banks! AccountTypes []string `json:"accountTypes,omitempty"` diff --git a/model/model_keyword_rule.go b/model/model_keyword_rule.go index 3948927..26b1d8d 100644 --- a/model/model_keyword_rule.go +++ b/model/model_keyword_rule.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_keyword_rule_identifiers_params.go b/model/model_keyword_rule_identifiers_params.go new file mode 100644 index 0000000..a32be77 --- /dev/null +++ b/model/model_keyword_rule_identifiers_params.go @@ -0,0 +1,16 @@ +/* + * finAPI RESTful Services + * + * finAPI RESTful Services + * + * API version: v1.93.0 + * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) + */ + +package finapi + +// Identifiers params +type KeywordRuleIdentifiersParams struct { + // List of identifiers + Ids []int64 `json:"ids"` +} diff --git a/model/model_keyword_rule_list.go b/model/model_keyword_rule_list.go index ca2f999..310839c 100644 --- a/model/model_keyword_rule_list.go +++ b/model/model_keyword_rule_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_keyword_rule_params.go b/model/model_keyword_rule_params.go index 95dff4a..ed4c381 100644 --- a/model/model_keyword_rule_params.go +++ b/model/model_keyword_rule_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_keyword_rules_params.go b/model/model_keyword_rules_params.go index cc7f249..256d710 100644 --- a/model/model_keyword_rules_params.go +++ b/model/model_keyword_rules_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_label.go b/model/model_label.go index 8f1518b..57d5727 100644 --- a/model/model_label.go +++ b/model/model_label.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_label_list.go b/model/model_label_list.go index b61fa0d..59bc798 100644 --- a/model/model_label_list.go +++ b/model/model_label_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_label_params.go b/model/model_label_params.go index eb1ae05..59fbcb7 100644 --- a/model/model_label_params.go +++ b/model/model_label_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_login_credential.go b/model/model_login_credential.go index 3a6fca6..63dd12e 100644 --- a/model/model_login_credential.go +++ b/model/model_login_credential.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_login_credential_resource.go b/model/model_login_credential_resource.go index 5877e4a..d987c3c 100644 --- a/model/model_login_credential_resource.go +++ b/model/model_login_credential_resource.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -13,6 +13,6 @@ package finapi type LoginCredentialResource struct { // Label for this login credential, as we suggest to show it to the user. Label string `json:"label,omitempty"` - // Stored value for this login credential + // Stored value for this login credential. Please NOTE:
• If a PIN is stored, this will always be 'XXXXX'.
• If your client has no license for processing banking credentials or if this field contains a value that requires password protection then this field will always be 'XXXXX'. Value string `json:"value,omitempty"` } diff --git a/model/model_mock_account_data.go b/model/model_mock_account_data.go index d5557ab..ecfaa0d 100644 --- a/model/model_mock_account_data.go +++ b/model/model_mock_account_data.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_mock_bank_connection_update.go b/model/model_mock_bank_connection_update.go index f1b07c2..1a01d83 100644 --- a/model/model_mock_bank_connection_update.go +++ b/model/model_mock_bank_connection_update.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_mock_batch_update_params.go b/model/model_mock_batch_update_params.go index fb163aa..80a87f3 100644 --- a/model/model_mock_batch_update_params.go +++ b/model/model_mock_batch_update_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_money_transfer_ordering_response.go b/model/model_money_transfer_ordering_response.go index d91b9de..04ef547 100644 --- a/model/model_money_transfer_ordering_response.go +++ b/model/model_money_transfer_ordering_response.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_monthly_user_stats.go b/model/model_monthly_user_stats.go index c56cd23..c76e58d 100644 --- a/model/model_monthly_user_stats.go +++ b/model/model_monthly_user_stats.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_multi_step_authentication_callback.go b/model/model_multi_step_authentication_callback.go index a2774c4..268b2c3 100644 --- a/model/model_multi_step_authentication_callback.go +++ b/model/model_multi_step_authentication_callback.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_multi_step_authentication_challenge.go b/model/model_multi_step_authentication_challenge.go index 27394f4..36095d7 100644 --- a/model/model_multi_step_authentication_challenge.go +++ b/model/model_multi_step_authentication_challenge.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -13,7 +13,7 @@ package finapi type MultiStepAuthenticationChallenge struct { // Hash for this multi-step authentication flow. Must be passed back to finAPI when continuing the flow. Hash string `json:"hash"` - // Indicates the current status of the multi-step authentication flow:
• CHALLENGE_RESPONSE_REQUIRED - means that the bank has sent a 'challengeMessage' which must be presented to the user. The user's answer must then be passed back to finAPI as 'challengeResponse';
• TWO_STEP_PROCEDURE_REQUIRED - means that the user has to select one of the 'twoStepProcedures'. The selection must then be passed back to finAPI as 'twoStepProcedureId';
• REDIRECT_REQUIRED - means that the bank has sent a 'redirectUrl', to which the user must be forwarded. The bank's callback must then be passed back to finAPI as 'redirectCallback'. + // Indicates the current status of the multi-step authentication flow:

TWO_STEP_PROCEDURE_REQUIRED means that the bank has requested an SCA method selection for the user. In this case, the service should be recalled with a chosen TSP-ID set to the 'twoStepProcedureId' field.
When the web form flow is used, the user is forwarded to finAPI's web form to prompt for his credentials (if they are not stored in finAPI) and to select the preferred SCA method.

CHALLENGE_RESPONSE_REQUIRED means that the bank has requested a challenge code for the previously given TSP (SCA). This status can be completed by setting the 'challengeResponse' field.
When the web form flow is used, the user should submit the challenge response for the challenge message shown by the web form.

REDIRECT_REQUIRED means that the user must be redirected to the bank's website, where the authentication can be finished.
When the web form flow is used, the user should visit the web form, get a redirect to the bank's website, complete the authentication and will then be redirected back to the web form.

DECOUPLED_AUTH_REQUIRED means that the bank has asked for the decoupled authentication. In this case, the 'decoupledCallback' field must be set to true to complete the authentication.

DECOUPLED_AUTH_IN_PROGRESS means that the bank is waiting for the completion of the decoupled authentication by the user. Until this is done, the service should be recalled with the 'decoupledCallback' field set to ‘true’. Once the decoupled authentication is completed by the user, the service returns a successful response. Status string `json:"status"` // In case of status = CHALLENGE_RESPONSE_REQUIRED, this field contains a message from the bank containing instructions for the user on how to proceed with the authorization. ChallengeMessage string `json:"challengeMessage,omitempty"` diff --git a/model/model_new_transaction.go b/model/model_new_transaction.go index de324d5..6954cb8 100644 --- a/model/model_new_transaction.go +++ b/model/model_new_transaction.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_notification_rule.go b/model/model_notification_rule.go index f9d41bd..4c938de 100644 --- a/model/model_notification_rule.go +++ b/model/model_notification_rule.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_notification_rule_list.go b/model/model_notification_rule_list.go index 1e0efb0..2ac07ae 100644 --- a/model/model_notification_rule_list.go +++ b/model/model_notification_rule_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_notification_rule_params.go b/model/model_notification_rule_params.go index 81d3e55..ca2e32b 100644 --- a/model/model_notification_rule_params.go +++ b/model/model_notification_rule_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_pageable_bank_list.go b/model/model_pageable_bank_list.go index a589b14..24ad1a8 100644 --- a/model/model_pageable_bank_list.go +++ b/model/model_pageable_bank_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_pageable_category_list.go b/model/model_pageable_category_list.go index 35299b8..a1d127d 100644 --- a/model/model_pageable_category_list.go +++ b/model/model_pageable_category_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_pageable_iban_rule_list.go b/model/model_pageable_iban_rule_list.go index c454e10..9d1cca7 100644 --- a/model/model_pageable_iban_rule_list.go +++ b/model/model_pageable_iban_rule_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_pageable_keyword_rule_list.go b/model/model_pageable_keyword_rule_list.go index a0bdd9d..4a98032 100644 --- a/model/model_pageable_keyword_rule_list.go +++ b/model/model_pageable_keyword_rule_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_pageable_label_list.go b/model/model_pageable_label_list.go index 90bd8eb..0000687 100644 --- a/model/model_pageable_label_list.go +++ b/model/model_pageable_label_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_pageable_payment_resources.go b/model/model_pageable_payment_resources.go index 2998371..515aa44 100644 --- a/model/model_pageable_payment_resources.go +++ b/model/model_pageable_payment_resources.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_pageable_security_list.go b/model/model_pageable_security_list.go index 70fbf18..bcac082 100644 --- a/model/model_pageable_security_list.go +++ b/model/model_pageable_security_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_pageable_tpp_authentication_group_resources.go b/model/model_pageable_tpp_authentication_group_resources.go index 2579564..b546dd9 100644 --- a/model/model_pageable_tpp_authentication_group_resources.go +++ b/model/model_pageable_tpp_authentication_group_resources.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_pageable_tpp_certificate_list.go b/model/model_pageable_tpp_certificate_list.go index 1d2630d..c0e66e6 100644 --- a/model/model_pageable_tpp_certificate_list.go +++ b/model/model_pageable_tpp_certificate_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_pageable_tpp_credential_resources.go b/model/model_pageable_tpp_credential_resources.go index 38b7f76..63e109f 100644 --- a/model/model_pageable_tpp_credential_resources.go +++ b/model/model_pageable_tpp_credential_resources.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_pageable_transaction_list.go b/model/model_pageable_transaction_list.go index d9ddb05..7669640 100644 --- a/model/model_pageable_transaction_list.go +++ b/model/model_pageable_transaction_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_pageable_user_info_list.go b/model/model_pageable_user_info_list.go index 2443069..7bb52c5 100644 --- a/model/model_pageable_user_info_list.go +++ b/model/model_pageable_user_info_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_paging.go b/model/model_paging.go index de28a79..a1586f4 100644 --- a/model/model_paging.go +++ b/model/model_paging.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_password_changing_resource.go b/model/model_password_changing_resource.go index 7a95022..b8c1583 100644 --- a/model/model_password_changing_resource.go +++ b/model/model_password_changing_resource.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_payment.go b/model/model_payment.go index e243754..7c25822 100644 --- a/model/model_payment.go +++ b/model/model_payment.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_payment_execution_response.go b/model/model_payment_execution_response.go index 9a322a4..5809b5f 100644 --- a/model/model_payment_execution_response.go +++ b/model/model_payment_execution_response.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_paypal_transaction_data.go b/model/model_paypal_transaction_data.go index 8e9b31f..59aea4d 100644 --- a/model/model_paypal_transaction_data.go +++ b/model/model_paypal_transaction_data.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_remove_interface_params.go b/model/model_remove_interface_params.go index 61b7769..6443d0c 100644 --- a/model/model_remove_interface_params.go +++ b/model/model_remove_interface_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_request_password_change_params.go b/model/model_request_password_change_params.go index 1b2c913..82d4cbd 100644 --- a/model/model_request_password_change_params.go +++ b/model/model_request_password_change_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_request_sepa_direct_debit_params.go b/model/model_request_sepa_direct_debit_params.go index ebf234e..df43929 100644 --- a/model/model_request_sepa_direct_debit_params.go +++ b/model/model_request_sepa_direct_debit_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_request_sepa_money_transfer_params.go b/model/model_request_sepa_money_transfer_params.go index 08575e9..99168cd 100644 --- a/model/model_request_sepa_money_transfer_params.go +++ b/model/model_request_sepa_money_transfer_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -15,10 +15,12 @@ type RequestSepaMoneyTransferParams struct { RecipientName string `json:"recipientName,omitempty"` // IBAN of the recipient's account. This field is optional only when you pass a clearing account as the recipient. Otherwise, this field is required. RecipientIban string `json:"recipientIban,omitempty"` - // BIC of the recipient's account. Note: This field is optional when you pass a clearing account as the recipient or if the bank connection of the account that you want to transfer money from supports the IBAN-Only money transfer. You can find this out via GET /bankConnections/. Also note that when a BIC is given, then this BIC will be used for the money transfer request independent of whether it is required or not (unless you pass a clearing account, in which case this field will always be ignored). + // BIC of the recipient's account. Note: This field is optional when you pass a clearing account as the recipient or if the bank connection of the account that you want to transfer money from supports the IBAN-Only money transfer. You can find this out via GET /bankConnections/. If no BIC is given, finAPI will try to recognize it using the given recipientIban value (if it's given). And then if the result value is not empty, it will be used for the money transfer request independent of whether it is required or not (unless you pass a clearing account, in which case the value will always be ignored). RecipientBic string `json:"recipientBic,omitempty"` // Identifier of a clearing account. If this field is set, then the fields 'recipientName', 'recipientIban' and 'recipientBic' will be ignored and the recipient account will be the specified clearing account. ClearingAccountId string `json:"clearingAccountId,omitempty"` + // End-To-End ID for the transfer transaction + EndToEndId string `json:"endToEndId,omitempty"` // The amount to transfer. Must be a positive decimal number with at most two decimal places (e.g. 99.99) Amount float32 `json:"amount"` // The purpose of the transfer transaction diff --git a/model/model_security.go b/model/model_security.go index b005dea..2ffa092 100644 --- a/model/model_security.go +++ b/model/model_security.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_security_list.go b/model/model_security_list.go index a61e7c7..0cbcaae 100644 --- a/model/model_security_list.go +++ b/model/model_security_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_single_direct_debit_data.go b/model/model_single_direct_debit_data.go index f9221ed..78c7389 100644 --- a/model/model_single_direct_debit_data.go +++ b/model/model_single_direct_debit_data.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -15,7 +15,7 @@ type SingleDirectDebitData struct { DebitorName string `json:"debitorName"` // IBAN of the debitor's account DebitorIban string `json:"debitorIban"` - // BIC of the debitor's account. Note: This field is optional if - and only if - the bank connection of the account that you want to transfer money to supports the IBAN-Only direct debit. You can find this out via GET /bankConnections/. Also note that when a BIC is given, then this BIC will be used for the direct debit request independent of whether it is required or not. + // BIC of the debitor's account. Note: This field is optional if - and only if - the bank connection of the account that you want to transfer money to supports the IBAN-Only direct debit. You can find this out via GET /bankConnections/. If no BIC is given, finAPI will try to recognize it using the given debitorIban value (if it's given). And then if the result value is not empty, it will be used for the direct debit request independent of whether it is required or not. DebitorBic string `json:"debitorBic,omitempty"` // The amount to transfer. Must be a positive decimal number with at most two decimal places (e.g. 99.99) Amount float32 `json:"amount"` diff --git a/model/model_single_money_transfer_recipient_data.go b/model/model_single_money_transfer_recipient_data.go index 6ccc051..cea63f3 100644 --- a/model/model_single_money_transfer_recipient_data.go +++ b/model/model_single_money_transfer_recipient_data.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -15,10 +15,12 @@ type SingleMoneyTransferRecipientData struct { RecipientName string `json:"recipientName,omitempty"` // IBAN of the recipient's account. This field is optional only when you pass a clearing account as the recipient. Otherwise, this field is required. RecipientIban string `json:"recipientIban,omitempty"` - // BIC of the recipient's account. Note: This field is optional when you pass a clearing account as the recipient or if the bank connection of the account that you want to transfer money from supports the IBAN-Only money transfer. You can find this out via GET /bankConnections/. Also note that when a BIC is given, then this BIC will be used for the money transfer request independent of whether it is required or not (unless you pass a clearing account, in which case this field will always be ignored). + // BIC of the recipient's account. Note: This field is optional when you pass a clearing account as the recipient or if the bank connection of the account that you want to transfer money from supports the IBAN-Only money transfer. You can find this out via GET /bankConnections/. If no BIC is given, finAPI will try to recognize it using the given recipientIban value (if it's given). And then if the result value is not empty, it will be used for the money transfer request independent of whether it is required or not (unless you pass a clearing account, in which case the value will always be ignored). RecipientBic string `json:"recipientBic,omitempty"` // Identifier of a clearing account. If this field is set, then the fields 'recipientName', 'recipientIban' and 'recipientBic' will be ignored and the recipient account will be the specified clearing account. ClearingAccountId string `json:"clearingAccountId,omitempty"` + // End-To-End ID for the transfer transaction + EndToEndId string `json:"endToEndId,omitempty"` // The amount to transfer. Must be a positive decimal number with at most two decimal places (e.g. 99.99) Amount float32 `json:"amount"` // The purpose of the transfer transaction diff --git a/model/model_split_transactions_params.go b/model/model_split_transactions_params.go index ec89308..b42d5ee 100644 --- a/model/model_split_transactions_params.go +++ b/model/model_split_transactions_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_sub_transaction_params.go b/model/model_sub_transaction_params.go index e111709..be2e882 100644 --- a/model/model_sub_transaction_params.go +++ b/model/model_sub_transaction_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_tpp_authentication_group.go b/model/model_tpp_authentication_group.go index f5870a1..075b75d 100644 --- a/model/model_tpp_authentication_group.go +++ b/model/model_tpp_authentication_group.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_tpp_certificate.go b/model/model_tpp_certificate.go index 27bc957..9dc5f6b 100644 --- a/model/model_tpp_certificate.go +++ b/model/model_tpp_certificate.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_tpp_certificate_params.go b/model/model_tpp_certificate_params.go index 1d2906f..d589b1e 100644 --- a/model/model_tpp_certificate_params.go +++ b/model/model_tpp_certificate_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -15,11 +15,11 @@ type TppCertificateParams struct { Type_ string `json:"type"` // A certificate (public key) PublicKey string `json:"publicKey"` - // A private key in PKCS #8 format. PKCS #8 private keys are typically exchanged in the PEM base64-encoded format (https://support.quovadisglobal.com/kb/a37/what-is-pem-format.aspx)

NOTE: The certificate should have one of the following headers:
- '-----BEGIN PRIVATE KEY-----'
- '-----BEGIN ENCRYPTED PRIVATE KEY-----'
Any other header denotes that the private key is NOT in PKCS #8 format! + // A private key in PKCS #8 or PKCS #1 format. PKCS #1/#8 private keys are typically exchanged in the PEM base64-encoded format (https://support.quovadisglobal.com/kb/a37/what-is-pem-format.aspx)

NOTE: The certificate should have one of the following headers:
- '-----BEGIN RSA PRIVATE KEY-----'
- '-----BEGIN PRIVATE KEY-----'
- '-----BEGIN ENCRYPTED PRIVATE KEY-----'
Any other header denotes that the private key is neither in PKCS #8 nor in PKCS #1 formats! PrivateKey string `json:"privateKey"` // Optional passphrase for the private key Passphrase string `json:"passphrase,omitempty"` - // Optional label to certificate to identify in the list of certificates + // A label for certificate to identify in the list of certificates Label string `json:"label"` // Start day of the certificate's validity, in the format 'YYYY-MM-DD'. Default is the passed certificate validFrom date ValidFromDate string `json:"validFromDate,omitempty"` diff --git a/model/model_tpp_credentials.go b/model/model_tpp_credentials.go index da31c85..a37513e 100644 --- a/model/model_tpp_credentials.go +++ b/model/model_tpp_credentials.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_tpp_credentials_params.go b/model/model_tpp_credentials_params.go index 2b07776..a0eeadb 100644 --- a/model/model_tpp_credentials_params.go +++ b/model/model_tpp_credentials_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -16,9 +16,9 @@ type TppCredentialsParams struct { // Optional label to credentials Label string `json:"label"` // ID of the TPP accessing the ASPSP API, as provided by the ASPSP as the result of registration - TppClientId string `json:"tppClientId"` + TppClientId string `json:"tppClientId,omitempty"` // Secret of the TPP accessing the ASPSP API, as provided by the ASPSP as the result of registration - TppClientSecret string `json:"tppClientSecret"` + TppClientSecret string `json:"tppClientSecret,omitempty"` // API Key provided by ASPSP as the result of registration TppApiKey string `json:"tppApiKey,omitempty"` // Credentials \"valid from\" date in the format 'YYYY-MM-DD'. Default is today's date diff --git a/model/model_train_categorization_data.go b/model/model_train_categorization_data.go index 99ee276..792ee05 100644 --- a/model/model_train_categorization_data.go +++ b/model/model_train_categorization_data.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_train_categorization_transaction_data.go b/model/model_train_categorization_transaction_data.go index 56b5b77..c0368c5 100644 --- a/model/model_train_categorization_transaction_data.go +++ b/model/model_train_categorization_transaction_data.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_transaction.go b/model/model_transaction.go index 1ce5552..7962fad 100644 --- a/model/model_transaction.go +++ b/model/model_transaction.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_transaction_list.go b/model/model_transaction_list.go index 2d91a91..0ccd21e 100644 --- a/model/model_transaction_list.go +++ b/model/model_transaction_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_trigger_categorization_params.go b/model/model_trigger_categorization_params.go index a0f83f1..ad3d1f9 100644 --- a/model/model_trigger_categorization_params.go +++ b/model/model_trigger_categorization_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_two_step_procedure.go b/model/model_two_step_procedure.go index 027d03a..5a6322a 100644 --- a/model/model_two_step_procedure.go +++ b/model/model_two_step_procedure.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_update_bank_connection_params.go b/model/model_update_bank_connection_params.go index 130a52e..8a41cbf 100644 --- a/model/model_update_bank_connection_params.go +++ b/model/model_update_bank_connection_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_update_multiple_transactions_params.go b/model/model_update_multiple_transactions_params.go index 3c8c6d5..284c81f 100644 --- a/model/model_update_multiple_transactions_params.go +++ b/model/model_update_multiple_transactions_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_update_result.go b/model/model_update_result.go index 60a3425..08e8819 100644 --- a/model/model_update_result.go +++ b/model/model_update_result.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_update_transactions_params.go b/model/model_update_transactions_params.go index 5b945e8..caf7c2a 100644 --- a/model/model_update_transactions_params.go +++ b/model/model_update_transactions_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_user.go b/model/model_user.go index 3d38fd7..aac52f7 100644 --- a/model/model_user.go +++ b/model/model_user.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_user_create_params.go b/model/model_user_create_params.go index 9be9912..bb25a73 100644 --- a/model/model_user_create_params.go +++ b/model/model_user_create_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ @@ -13,7 +13,7 @@ package finapi type UserCreateParams struct { // User's identifier. Max length is 36 symbols. Only the following symbols are allowed: 0-9, A-Z, a-z, -, _, ., +, @. If not specified, then a unique random value will be generated. Id string `json:"id,omitempty"` - // User's password. Minimum length is 6, and maximum length is 36. If not specified, then a unique random value will be generated. + // User's password. Minimum length is 6, and maximum length is 128. If not specified, then a unique random value will be generated. Password string `json:"password,omitempty"` // User's email address. Maximum length is 320. Email string `json:"email,omitempty"` diff --git a/model/model_user_identifiers_list.go b/model/model_user_identifiers_list.go index 930b4b7..c99eced 100644 --- a/model/model_user_identifiers_list.go +++ b/model/model_user_identifiers_list.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_user_identifiers_params.go b/model/model_user_identifiers_params.go index 30d094a..13fbb96 100644 --- a/model/model_user_identifiers_params.go +++ b/model/model_user_identifiers_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_user_info.go b/model/model_user_info.go index b362ccd..2156cc3 100644 --- a/model/model_user_info.go +++ b/model/model_user_info.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_user_update_params.go b/model/model_user_update_params.go index da490df..8ce5561 100644 --- a/model/model_user_update_params.go +++ b/model/model_user_update_params.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_verification_status_resource.go b/model/model_verification_status_resource.go index e17889d..db288a0 100644 --- a/model/model_verification_status_resource.go +++ b/model/model_verification_status_resource.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/model/model_web_form.go b/model/model_web_form.go index 598ba60..404fdd4 100644 --- a/model/model_web_form.go +++ b/model/model_web_form.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */ diff --git a/response.go b/response.go index f56e910..b1fb784 100644 --- a/response.go +++ b/response.go @@ -3,7 +3,7 @@ * * finAPI RESTful Services * - * API version: v1.79.0 + * API version: v1.93.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git) */