Changelog
Version 2.7.1 (11.12.2024)
- Add
state
,errors
andwarnings
to the response model of GetAccountType endpoint to provide information about current PSP status.
Version 2.7.0 (05.11.2024)
-
New classification
Tax
(e.g. sales taxes). -
New classification
Adjustment
for miscellaneous adjustments (e.g. rounding errors). -
Add
excludeDeprecatedFields
as a parameter to GetTransactions and GetTransaction. Setting this parameter totrue
will exclude the transaction fields that are marked as deprecated from the list offields
. -
Add
excludeMappedFields
as a parameter to GetTransactions and GetTransaction. Setting this parameter totrue
will exclude the transaction fields that are mapped to one of the fixed transaction fields such asorderNumber
orbookingText
. -
Add
errors
andwarnings
to the response models of account, report and data import in GetAccount, GetAccounts, GetReport, GetReports, GetDataImport and GetDataImports. -
Add
errors
to the response model of account in CreateAccount and UpdateAccount.
Version 2.6.1 (26.09.2024)
-
Ensure date-time values always have the same number of fractional seconds. Previously zeros were truncated but the full available resolution of the timestamp was provided.
Before After 2024-06-16T06:01:29Z
2024-06-16T06:01:29.0000000Z
2024-09-25T07:51:06.352486Z
2024-09-25T07:51:06.3524860Z
Version 2.6.0 (26.08.2024)
- Add data imports controller with endpoints:
GET /dataimports
- to get a list of data importsGET /dataimports/{id}
- to get information about a data import
Version 2.5.0 (25.07.2024)
-
Changed endpoints:
- The list of
transactionField
s of the account type metadata now containsisDeprecated
anddeprecationReason
properties to indicate that a field should not be used anymore. - The change partner's own settings endpoint now contains a new
uiSettings.styling
property to allow customization of the Account UI. See the styling documentation for details. - Add
name
,email
andsearch
as parameters to GetUsers
- The list of
-
Metadata updates for most account types (see 2024-07 Metadata Updates)
- New, more descriptive fields IDs and names (e.g.
payoutId
instead ofreference1
). - Deprecation of old field names.
- Removal of 'bookingDate' and 'valueDate' from the transaction fields as the values only duplicated information from the main transaction.
- Removal of fields that were never used by a PSP.
- Removal of fields with dubious data quality.
- New, more descriptive fields IDs and names (e.g.
Version 2.4.0 (01.07.2024)
- Changed endpoints:
- All changes are backwards compatible. However, there are deprecations that will be removed in the future. The new API offers more flexibility and features.
POST /accountui
:- Add
accountTypeIds
as request / response body parameter - Deprecate
accountTypeId
as request / response body parameter - useaccountTypeIds
instead - See create or update an account
- Add
GET /accountui/{id}
:- Add
accountTypeIds
as response body parameter - Deprecate
accountTypeId
as response body parameter - useaccountTypeIds
instead - See get the status of an account UI session
- Add
Version 2.3.0 (22.04.2024)
-
Add account UI controller with endpoints (beta):
POST /accountui
- to create or update an accountGET /accountui/{id}
- to get the status and results of an account UI session
-
Add
uiSetings
as a parameter to CreatePartner and to UpdatePartner and to their response models
Version 2.2.2 (05.03.2024)
- Add
pageReference
as a parameter to GetTransactions - Add
previousPageReference
andnextPageReference
to the response model of GetTransactions
Version 2.2.1 (29.02.2024)
- Add
createdAt
as a search parameter to GetTransactions
Version 2.2.0 (20.02.2024)
- Add reports controller to get a list of transaction reports or a single report
Version 2.1.6 (11.01.2024)
- Add an endpoint GetTransaction to get a single transaction by ID
- Add a new GetTransactions endpoint. The existing endpoint is renamed to GetTransactionsDeprecated and should not be used for new development.
- Add
reportId
as a search parameter to GetTransactions
Version 2.1.5 (21.11.2023)
- Add
deletedAt
to deleted users in GetUsers
Version 2.1.4 (09.10.2023)
- Add user update method
- Allow changing child partner's name in the partner update method
Version 2.1.3 (12.05.2023)
- Add
helpUrls
to account types.
Version 2.1.2 (02.05.2023)
- Add child partner delete methods
Version 2.1.1 (27.04.2023)
- Add partner token revocation and usage timestamps
Version 2.1.0 (24.04.2023)
- Add account credentials validation methods
Version 2.0.0-beta3 (31.03.2023)
- Add rate limiting
Version 2.0.0-beta2 (23.02.2023)
- The
redirectUrl
prorerty has been added to the POST /oauth request model, which allows to specify the redirect URL for any particular request. - Breaking changes
- Partner request and response models have been changed. The
redirectUrl
prorerty has been removed and theredirectUrls
prorerty has been added instead, which allows to specify multiple redirect URLs.
- Partner request and response models have been changed. The
Version 2.0.0-beta1 (17.02.2023)
- Add partner tokens and allow partners to add other partners.
- Add scopes to partner and user tokens.
- New endpoints
POST /partners
GET /partners/self
PUT /partners/self
GET /partners/{id}
PUT /partners/{id}
POST /partners/{id}/tokens
POST /partners/self/tokens
DELETE /partners/{id}/tokens/{tokenId}
GET /partners/self/tokens
GET /partners/{id}/tokens
POST /users/{id}/tokens
. ReplacesGET /users/{id}/token
.GET /users/{id}
. ReplacesGET /users/{name}
. A user token and a user ID are added to the response model. An optional Email parameter is added to the response model.
- Endpoints with extended request or response models, non-breaking changes
POST /users
. A user token and a user ID are added to the response model. An optional Email parameter is added to both request and response models.
- Breaking changes
- Partner authentication with API-keys has been removed. JWT bearer tokens should be used instead. All partner keys must be replaced with the tokens.
- Transaction CreationTimestamp was renamed to CreatedAt
- All user tokens should be updated to contain scopes. For that the
POST /users/{id}/tokens
endpoint can be used.
- The following endpoints have been removed
GET /users/{id}/token
.POST /users/{id}/token
should be used instead. The response model has changed.PATCH /partners
.PUT /partners/self
should be used instead.
- The following endpoints have been changed
GET /partners
.GET /partners/self
should be used instead.GET /users/{name}
.GET /users/{id}
should be used instead.DELETE /users/{name}
.GET /users/{id}
should be used instead.
Version 1.1.2
- Make user token expiry configurable.
Version 1.1.1
- Internal bug fix release.
Version 1.1.0
- Add report information to transactions.
Version 1.0.0
- Initial version.