Changelog
List of changes in this documentation.
2024-11-27
- Added data types to the Flanks Data Model endpoint.
2024-11-07
- Added
ignore_data_error
parameter to the Aggregation API endpoints.
Specified in Ignore Data Error.
2024-10-09
- Added new field tax_type to the Portfolio Data Model.
2024-09-19
- Removed deprecated norma43 field from Account Transactions' Data Model.
2024-09-09
- Removed deprecated Get All Credential's Data endpoint from Aggregation API.
2024-07-02
- Removed deprecated Get MIFID endpoint from Aggregation API.
2024-01-18
- Removed Get Investment Detail endpoint from Aggregation
API. This endpoint was redundant
because the same information is available under the
detail
field of the Get Investments endpoint.
2023-12-22
- Removed
client_id
parameter from Get Unused Link Codes endpoint.
2023-12-20
- Added a new return field
link_token
(indicating from which link the credencials were created) to the following endpoints:
2023-10-10
Changes in the Get Unused Link Codes endpoint:
* Renamed from LINK CODES
* The client_id
filter is now optional
* Added New filter link_token
.
2023-10-04
- Documented new Testbank features:
- Include
SCA_TYPE_NOT_ALLOWED
andUSER_INTERACTION_NEEDED
as special passwords to generate those specific errors. - Include
SCA_TYPE_NOT_ALLOWED
andUSER_INTERACTION_NEEDED
errors.
- Include
2023-09-12
- Fixed the description of the
pending
field in the Credential Status. It should be set tofalse
once the initial data fetching is complete.
2023-09-04
- To enhance security consistency, we are implementing an update in the way we return PAN (Primary Account Number) codes to Flanks. Previously, we were displaying exactly as they were provided by the financial institution. However, from now on, the digits will be completely masked (******) except for the last four ones. This change will apply to both existing and new data retrieved by Flanks. For data where the PAN code was not properly masked, we will be making necessary updates, which could result in changes. The fields that could change their value are:
- fields
_id
andpan
for the Cards model. - fields
_id
andcard_id
for the Card Transactions model.
- fields
- Deprecate
password
grant support from our Authentication flows.
2023-08-21
- Changed List Credentials endpoint
path from
/credentials/v0/list
to/v0/bank/credentials/list
.
2023-08-08
- Added a new section describing how to encrypt requests to Flanks' APIs on top of HTTPS using JWT (Request Encryption)
2023-07-27
- Added
paymentCurrency
andexchangeToPaymentCurrency
fields to the Investment Transactions model. Now, all transaction amounts can be read or easily converted to all involved currencies: portfolio, investment, transaction and payment (account). All currencies and exchanges in an investment transaction are like this:currency
: Currency in which all transaction amounts are expressed. It's the same as the investment currency.transactionCurrency
: Currency in which transaction values were reported.paymentCurrency
: Currency of the account in which the transaction was paid.originalCurrency
: The currency of the investment.referenceCurrency
: The currency of the portfolio.exchange
: Multiplier to convert fromoriginalCurrency
toreferenceCurrency
(investment -> portfolio)exchangeToTransactionCurrency
: Multiplier to convert fromoriginalCurrency
totransactionCurrency
(investment -> transaction)exchangeToPaymentCurrency
: Multiplier to convert fromoriginalCurrency
topaymentCurrency
(investment -> account)
2023-06-16
- Added
transactionCurrency
andexchangeToTransactionCurrency
fields to the Investment Transactions model.
2023-06-09
- Document List Credentials endpoint
2023-05-09
- Added missing fields (
_id
,account_id
,card_id
,investment_id
,liability_id
,portfolio_id
) to the Query Object section.
2023-04-19
- Added
reversal_type
field to Investment Transactions model.
2023-03-30
- Added fields to Liabilities model:
contractNumber
, obtained from the financial institution's website.interest
, information about the liability interest.subtype
, only for loans indicate if it is a mortgage or not.
2023-03-27
- Added timestamp fields in UTC to the following models:
- Portfolios:
last_update_timestamp
- Investments:
last_update_timestamp
- Accounts:
last_update_timestamp
- Liabilities:
last_update_timestamp
- Card:
last_update_timestamp
- All Credentials' Data:
last_update_timestamp
- Portfolios:
- Added timestamp fields in UTC to
Credential Status:
created_at_timestamp
last_update_timestamp
2023-03-09
- Added behavior description of the Get All Credential's Data endpoint.
2023-02-22
- Added a new page TestBank to this documentation. It explains the special features that can be used when using TestBank to add new credentials through our link.
2023-02-10
- Added
order_id
to the following models:
2023-02-07
- The endpoint for investment transactions was incorrectly documented as
v0/bank/credentials/investment/transactions
(plural), but the correct one is, in fact,v0/bank/credentials/investment/transaction
(singular). This has been corrected. Both URLs are still valid (and work exactly the same) but we'll discontinue the support for the wrong one by Q2 2023.
2023-01-26
- Added the following Investment Transaction Types:
- Type 63, meaning "Buy open"
- Type 64, meaning "Buy close"
- Type 65, meaning "Sell open"
- Type 66, meaning "Sell close"
2023-01-15
- Added
placing_bank
to the Investment Transactions model.
2023-01-05
- Added Type 49 in Investment Transaction Types, meaning "Variation Margin".
2022-12-27
- Added transaction_id to the following models:
2022-12-19
- Added
pair_transaction_id
to the Account Transactions model.