Deprecations of Bookings, Balances, Fees and Reports

As part of our ongoing efforts to improve our platform and provide more secure, efficient, and scalable solutions, we will be deprecating several endpoints and reports with full retirement scheduled for 18th of November 2025.

Improvements:

• Resolving discrepancies in the Balance calculations
• Bank Statement Report and Bookings now utilizes Transaction Date rather than Value Date to rationalize the interpretation of Balance data
• Continuous streamlining and optimizing of our API offering, with improved error responses and simplifying the Report capabilities

What This Means for You:

• This document will provide information on the technical changes, in addition to providing resources to enable a smooth migration
• After the End of Life (EOL) date, 18th of November, the APIs will be fully retired and become unavailable
• All deprecated endpoints have alternatives to migrate to. The migration must be completed before the 18th of November to ensure continued functionality

Affected APIs and Endpoints:

ACCOUNTS & BALANCES

• Deprecated: Get bookings of an account (V1 and V2)
• Replacement: Get bookings of an account (V3)
• Key Changes:
  • Parameter valueDateFrom replaced with dateFrom
  • Parameter valueDateTo replaced with dateTo
  • Response includes:
    • New id property
    • Bookings for Interests and Sweeps included in response, defined via transactionType
  • Field Balance in response is nullable and will contain a value only for requests that are not filtered
  • Transaction date is utilized instead of Value Date to simplify the interpretation of the data
  • Resolving the cases of Balance discrepancies

REPORTING AND RECONCILIATION

Bank Statement Report

• Deprecated: Bank statement report (V2)
• Replacement: Bank statement report (V3)
• Key Changes:
  • Parameter valueDateFrom replaced with dateFrom
  • Parameter valueDateTo replaced with dateTo
  • New error type: InvalidReportVersion
  • Transaction date is utilized instead of Value Date to simplify the interpretation of the data
  • Resolving the cases of Balance discrepancies
  • Minor PDF structure updates

Request Report

• Deprecated: Request Report (V2)
• Replacement: Account activity report & Reconciliation report, which offers the same capabilities

Get Status of Requested Report & Get List of Requested Reports

• Deprecated: Get status of requested report (V1) & Get list of requested reports (V1)
• Replacement: Get status of requested report (V2) & Get list of requested reports (V2)
• Key Changes: Improved error responses

FEES & INTERESTS

Get all Fee

• Deprecated: Get all Fee (V1)
• Replacement: Get all Fee (V2) & Get all Interest (V1)
• Key Changes, Get all Fees (V2)
  • Only includes Fee transactions not Interests
  • New field called Id (It is unique id for fees)
  • feeId is nullable (It is null for Due fees)
  • status's values ("Unknown", "MissingFunding", "PendingProcessing", "Cancelled", "Processed") changed to ("Unknown", "Paid", "Due", "Upcoming")
• Key Changes, Get all Interests (V1)
  • Only includes Interest transactions
  • New field called Id (It is unique id for Interests)
  • InterestId is nullable (It is null for Due Interests)
  • status's values ("Unknown", "Paid", "Due")

Get single Fee/Interest

• Deprecated: Get single Fee/Interest (V1)
• Replacement: Get single Fee (V2) & Get single Interest (V1)
• Key Changes, Get single Fee (V2)
  • Get single fee only includes Fee transactions
  • A specific fee can be fetched by providing the Id which is integer
  • feeId is nullable (It is null for Due fee)
  • status's values ("Unknown", "MissingFunding", "PendingProcessing", "Cancelled", "Processed") changed to ("Unknown", "Paid", "Due", "Upcoming")
• Key Changes, Get single Interest (V1)
  • Get single Interest only incudes Interest Transactions
  • A specific Interest can be fetched by providing the Id which is integer
  • InterestId is nullable (It is null for Due Interest)
  • status's values ("Unknown", "Paid", "Due")
  
  

Resources to Assist You:

API Documentation: Banking Circle Connect API Reference

Need Help?

Our team is here to support you through this transition. If you have any questions or need assistance with the migration, please don’t hesitate to reach out to us at [email protected].

We appreciate your understanding and cooperation as we work to provide better and more secure services for all our users.