How Deprecation Works

When a product, feature, API endpoint is deprecated it begins on the deprecation notice date. The functionality is then considered Deprecated during a deprecation grace period, until it is effectively Decomissioned (removed).

📘 Key term: Deprecated means a feature, API endpoint, behaviour etc is still available but should no longer be used. Reasons may include:

• A better alternative exists, e.g. a new API endpoint.
• The functionality is about to be decommissioned (removed).

📘 Key term: Decomissioned means a feature, API endpoint, a field in a API request/response structure etc is no longer supported and may have been removed. Calling such an endpoint, or relying on deprecated properties in API responses may led to unpredictable behaviour.

Active Deprecations

The following section lists deprecations, removals of functionality or changes in behavior impacting the Atlar API and products.

v1 Account.balance

Deprecation notice date: 2024-08-16

Decomissioned date: TBA

Scope: API v1, resource Account.

The property Account.balance is deprecated. Instead, use the API endpoint List Balances.

v1 Transaction field account.bank.name and account.bank.id

Decomissioned date: 2023-08-14

Deprecation notice date: -

Scope: API v1, resource Transactions.

Transactions impacting accounts created after the effective deprecation date will not have the fields account.bank.name and account.bank.id populated. The values will be an empty string. Note though that account.bank.bic will still be populated when available.