Changelog

Please when integrating consider that Flanks can add fields to any endpoint, all changes will be tracked here.

2024-01-18

• Remove INVESTMENT DETAIL endpoint. All the information is already available under the INVESTMENT endpoint.

2023-12-22

• GET UNUSED LINK CODES removed client_id parameter

2023-12-20

• GET UNUSED LINK CODES and EXCHANGE LINK CODE FOR CREDENTIALS TOKENendpoints now returns the link_token field, this indicates from which link this credential was connected.

2023-10-10

• Rename Endpoint LINK CODES to GET UNUSED LINK CODES
• Now client_id will be optional and not required to use GET UNUSED LINK CODES endpoint. Also add a new filter for link_token.

2023-10-04

• Testbank:

  Include SCA_TYPE_NOT_ALLOWED and USER_INTERACTION_NEEDED as special passwords to generate the specific errors.

• Link Errors:

  Include new errors, SCA_TYPE_NOT_ALLOWED and USER_INTERACTION_NEEDED.

2023-09-12

• Fixed the description of the pending field in the credential status endpoint. It should be set to false 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 possibly change their value are:

  • For the endpoint v0/bank/card: fields _id, pan

  • For the endpoint v0/bank/card/transaction: fields _id, card_id

• Deprecate password grant support from our authentication flows.

2023-08-21

• Change LIST CREDENTIALS TOKENS 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 and exchangeToPaymentCurrency fields to v0/bank/credentials/investment/transaction endpoint. 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 transaction was paid.

  • originalCurrency: The currency of the investment.

  • referenceCurrency: The currency of the portfolio.

  • exchange: Multiplier to convert from originalCurrency to referenceCurrency (investment -> portfolio)

  • exchangeToTransactionCurrency: Multiplier to convert from originalCurrency to transactionCurrency (investment -> transaction)

  • exchangeToPaymentCurrency: Multiplier to convert from originalCurrency to paymentCurrency (investment -> account)

2023-06-16

• Added transactionCurrency and exchangeToTransactionCurrency fields to v0/bank/credentials/investment/transaction endpoint.

2023-06-09

• Document endpoint credentials/v0/list

2023-05-09

• Completed "Query Engine" documentation with more available fields (_id, account_id, card_id, investment_id, liability_id, portfolio_id).

2023-04-19

• Add reversal_type field to v0/bank/credentials/investment/transaction endpoint.

2023-03-30

• Add fields to v0/bank/credentials/liability endpoint

  • field contractNumber, obtained from the financial institution website

  • field interest, information about the liability interest

  • field subtype, only for loans indicate if its mortgage or not

2023-03-27

• Add timestamp fields in UTC:

  • credentials/status: created_at_timestamp

  • credentials/status: last_update_timestamp

  • credentials/portfolio: updated_at_timestamp

  • credentials/investment: updated_at_timestamp

  • credentials/account: updated_at_timestamp

  • credentials/liability updated_at_timestamp

  • credentials/card: updated_at_timestamp

  • credentials/all: updated_at_timestamp

2023-03-09

• Add behaviour description of the v0/bank/credentials/all endpoint

2023-02-22

• A new page TestBank has been added 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

• order_id field is added to the response of endpoints:

  • v0/bank/credentials/liability/transaction

  • v0/bank/credentials/investment/transaction

  • v0/bank/credentials/data

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

• Type 63 for investment transaction types added meaning "Buy open"

• Type 64 for investment transaction types added meaning "Buy close"

• Type 65 for investment transaction types added meaning "Sell open"

• Type 66 for investment transaction types added meaning "Sell close"

2023-01-15

• placing_bank field is added to the response of v0/bank/credentials/investment

2023-01-05

• Type 49 for investment transaction type added meaning "Variation Margin"

2022-12-27

• transaction_id field is added to the response of endpoints

  • v0/bank/credentials/data

  • v0/bank/credentials/investment/transaction

  • v0/bank/credentials/liability/transaction

2022-12-19

• pair_transaction_id field is added to the response of v0/bank/credentials/data