Introduction
Changelog
Authentication
Headers
Errors
Rate Limiting
OAuth 2.0
User
Devices
Aggregation
Bills
Budgets
Challenges
CDR
Configuration
Events
Goals
Messages
Pay Day
Payments
Reports
Surveys
Calculators
Images
Users
Accounts
Transactions

Changelog

Changes to the platform, Client API and Management API

2.11

Client API

General

Errors

  • APIs may now return a new Error code - F0120 - OTP required requiring an OTP to be provided via X-User-Otp if security requires it. See Authentication for details

Client API

Aggregation

CDR

  • Added support for passing existing_consent_id to the Create Consent
  • Changed the default behaviour of Create Consent to create a new one for each Provider instead of replacing existing consents (AKA concurrent consent)

Configuration

Payments

User Details

2020/11/13

2.10

Client API
Management API
Webhooks

Management API

Authentication

  • Management API now supports Client Credentials OAuth 2.0 grant flow

Client API

Aggregation

  • Joint Accounts are now supported using the Create Account Management API
  • Added support for creating Accounts with user assigned specific roles
  • Added image URLs and addition transaction category details to Transactions

Bills

  • Added merchant and category image URLs to Bills

Budgets

Goals

  • Added the Get Goal Log endpoint to provide change history of Goals
  • Added support for backdating Create Goal with completed periods using the suppress_events and completed_backdated_periods parameters
  • Added the ability to filter List Goals by account_id
  • Added additional status filters to allow calling List Goals with multiple statuses at once
  • Changed Get Goal to return Goals with cancelled status too

Reports

  • Added merchant or category image URLs to Reports where applicable
  • Added the category_type property to Reports where applicable

Webhooks

Events

  • Added ACCOUNT_ID substitution to various Goal events

2020/07/06

2.9

Client API

Client API

Aggregation

Budgets

  • Renamed Budget index parameters

CDR

2.5

Client API

Client API

Aggregation

  • Added external_id property to the Account object.
  • Added budget_apply_all parameter to the Transaction
  • Removed aggregator_id from the Account object.

Budgets

  • Added Budgets V2

2019/09/23

2.4

Client API

Client API

Aggregation

  • Added goal_ids on /aggregation/accounts/

Reports

2019/07/12

2.3

Client API

Client API

User

  • Added client_id on /user/reset and /user/register

2019/06/11

2.2

Client API

Client API

Aggregation

Bills

  • Changed due_amount data type to string for Bill create/update
  • Changed longitude and latitude data types to decimals
  • Changed description property on the Bill object to be optional

Reports

  • Added Tags Reports API endpoint

User

2019/05/30

2.1

Client API

Client API

  • Device details are now optional on User Registration endpoint
  • Added transaction enrichment data fields to the Transactions API
  • Added compliance attribute to Update Device Request
  • Added merchant_ids filter to List Merchants API
  • Added Surveys API
  • Updated UserSurvey model
  • Added latest query param to Surveys API
  • Added answer_type UserSurvey model
  • Changed normal_selection to selection
  • Added auto_dismiss property to Message object
  • Changed unpayable property to required from optional optional in BillPayment

2019/04/09

2.0

Client API

Client API

  • Updated Message object for V2
  • Updated Reports - History for V2
  • Updated Reports - Current for V2
  • Added new custom headers that replace the User-Agent header from V1
  • Added mobile_number to User Details object
  • Exposed postcode through the User Registration API
  • Added Rate Limiting section
  • Added Transaction Search API
  • Updated the Create Bill API to include information on creating a Bill without an existing transaction
  • Updated the Transaction History Reports API URL structure and API response
  • Updated the Transaction Current Reports API URL structure and API response
  • Renamed ‘clicked’ property to ‘interacted’ for the Update Message API
  • Updated the Security section to add information about OAuth
  • Removed reference to client_secret as it is no longer needed
  • Added Note On OAuth Error Codes that describes what Error Codes were deprecated in the OAuth Security update
  • Updated the OAuth Token Request object to include the code_verifier property for PKCE

2019/03/04

Revisions

Version Date Author Summary
V2.06.01 2019/11/26 Gaëtan Guéraud
  • Added additonal fields to Survey and SurveyQuestion.
V2.06.02 2019/11/27 Gaëtan Guéraud
  • Added metadata to Message.
V2.07.00 2019/11/14 Bruno Sapienza
  • Added Pagination to merchants.
V2.07.01 2019/12/16 Gaëtan Guéraud
  • Rename next_transaction_date and last_transaction_date to next_date and previous_date respectively for PayDay.
V2.07.02 2020/01/06 Brett Hopper
  • Added aggregator_type and permissions properties to the Provider object.
V2.07.03 2020/01/10 Brett Hopper
  • Updated the Goals API to Version 2, replacing the deprecated Goals API.
V2.07.04 2020/01/15 Brett Hopper
  • Added large_logo_url and large_logo_revision to the GET Providers API.
V2.07.05 2020/01/28 Brett Hopper
V2.07.06 2020/01/29 Gaëtan Guéraud
  • Updated Merchants api pagination, added total.
V2.07.07 2020/01/29 Brett Hopper
V2.07.08 2020/01/29 Brett Hopper
V2.08.01 2020/01/29 Brett Hopper
V2.08.02 2020/01/30 Brett Hopper
  • Added the KYC section.
V2.08.03 2020/02/05 Brett Hopper
  • Added information about accessing these APIs using the API Key Method.
V2.08.04 2020/02/10 Brett Hopper
  • Added Consent information to the Provider Account object.
V2.08.05 2020/02/24 Gaetan Gueraud
  • Added new Budget docs and remove old one.
V2.08.06 2020/02/24 Gaetan Gueraud
  • Added new Reports docs.
V2.08.07 2020/02/25 Gaetan Gueraud
  • Added Reports by Tag.
V2.08.08 2020/02/25 Brett Hopper
  • Changed Consent.sharing_duration to nullable. This is because Yodlee Consents do not have a duration.
V2.08.09 2020/02/27 Brett Hopper
  • Added CDR Product APIs
V2.08.10 2020/03/02 Brett Hopper
V2.08.11 2020/09/03 Gaetan Gueraud
  • Budgets by Account