Breaking Changes
- End-Of-Life versions of Node.js as of October 2023 are no longer supported. Supports Node.js 18, 20, and future releases.
Features
- Add permissionsAction to authorisation URL generation methods.
- Add customerIpAddress and customerLastLoggedTime to createAuthRequest
Features
- Add OSIP methods
Bug Fixes
- Change registerUser's clientUserId type annotation to be optional
Features
- Add detectRegularTransactions
Features
- Requests to query data can have client provided access tokens passed in, instead of relying on us to request an access token per request. Thus allowing to complete single use with the client library.
Features
- All authorisation URL generating methods use Pushed Authorisation Requests (PAR) instead of JWT Secured Authorisation Requests (JAR)
Features
- Add accountsList
- Add accountsListWithDetails
Features
- Add addAccountBalance
- Add updateAccount
Features
- Rename transactionsFromDateTime to
transactionFromDateTime
for auth requests body
Features
- Update exchangeCodeForTokens to make
nonce
optional
Features
- Update getAccountCounterparties to include version
- Update getPaymentAuthorizeUrl to accept a payee instead of payeeId
- Update getRecurringPaymentAuthorizeUrl to accept a payee instead of payeeId
- Update getStandingOrderAuthorizeUrl to accept a payee instead of payeeId
- Update create-payement example to accept a payee instead of payeeId
- Update create-standing-order example to accept a payee instead of payeeId
Features
- Migrated API client to Typescript
- Update getReversePaymentAuthorizeUrl to accept payerId and payerType
Bug fixes
- Fix form data for addFileToTransaction
Features
- Add listBetaConnections
- Add getReconsentAuthorizeUrlForCreatedUser
- Add updateUserConnection
Features
- Add getSpendingAnalysis
Features
- Add getSync
- Add getConnectionSyncs
Features
- Add AIS consent options to following methods:
getAuthorizeUrl
getAuthorizeUrlForCreatedUser
getReauthAuthorizeUrlForCreatedUser
getRefreshAuthorizeUrlForCreatedUser
Features
- Add getRentalRecords
- Add createRentalRecord
- Add deleteRentalRecord
Features
- Allow passing requests timeout
- Allow passing Identity service url without
/oidc
suffix
Bug Fixes
- Update
openid-client
andgot
to fix security vulnerabilities
Breaking Changes
-
Normalisation of all methods to use object destructuring to pass parameters. Please refer to the docs of each method when migrating to this version
-
Delete methods only return the status code when succesful
-
All methods to retrieve data return the body response as json, on previous versions some methods were returning the full response from the got library.
-
When our API response code is not 2xx an HTTP error is thrown. Includes a response property with more information.
-
Removal of all the methods with the suffix
WithToken
. To migrate to this version you can use the method with the same name but without the suffix. e.ggetUserConnectionsWithToken()
=>getUserConnections()
- registerUserWithToken
- getUserConnectionsWithToken
- deleteUserConnectionWithToken
- deleteUserWithToken
- getAccountsWithToken
- getAccountWithToken
- getAccountHoldingsWithToken
- getTransactionsWithToken
- syncUserConnectionWithToken
- Add getGlobalCounterparties
- Add addFileToTransaction
- Add getTransactionFiles
- Add getTransactionFile
- Add deleteTransactionFile
- Add getAccountCounterparties
- Add getAccountRecurringTransactions
- Add CRUD project actions
- Project ID query added to transaction end point
- Added payer id and types to payment request
- Add getPaymentFromIDToken method
- Add support for sending
sub
when exchanging the auth code - Allow passing local params when exchanging the auth code
- Add sync connection methods
- Allow passing params to getAccounts and getTransactions
- Change getAccounts method to receive userId instead of token
- Add getAccountsWithToken
- Change getTransactions method to receive userId instead of token
- Add getTransactionsWithToken
- Update examples to use command-line-args
- Add getAccount method