2022/12/09 - Public REST APIs Quarterly Update

Hive Fairways Debt ecosystem provides a number of public REST APIs. Please refer to our official developer API documentation website for further information: https://developer.financeactive.com/api.html

The list of APIs referred in this documentation is the comprehensive list of the public and supported APIs. Therefore, the usage of any endpoints outside of this list is deemed unsupported: these endpoints can be modified or removed without notice. Please also note that such endpoints are not expected to be certified through our QA process.

Each time a new version of one public API is published, the previous version of this API remains supported for one year, before it becomes fully deprecated and thus unsupported. There is no limit regarding the number of versions for the same API which can be supported at a given time if several versions are published throughout a short period of time.

APIs added in Q4 2022

Here below is the list of the APIs added in Q4 2022 for Guarantor Portal:

  • Listing requests: /gp/api/v1/guarantors/{guarantor_id}/requests. Click here for further information.
  • Retrieving an amendment: /gp/api/v1/guarantors/{guarantor_id}/amendments/{request_id}. Click here for further information.
  • Retrieving an extend or pay: /gp/api/v1/guarantors/{guarantor_id}/extend-or-pays/{request_id}. Click here for further information.
  • Retrieving a guarantee request: /gp/api/v1/guarantors/{guarantor_id}/guarantee-requests/{request_id}. Click here for further information.
  • Retrieving a release: /gp/api/v1/guarantors/{guarantor_id}/releases/{request_id}. Click here for further information.
  • Listing clients: /gp/api/v1/guarantors/{guarantor_id}/clients. Click here for further information.
  • Listing request documents: /gp/api/v1/guarantors/{guarantor_id}/requests/{request_id}/documents. Click here for further information.
  • Get document content: /gp/api/v1/guarantors/{guarantor_id}/requests/{request_id}/documents/
    {document_id}/content. Click here for further information.
  • Listing request comments: /gp/api/v1/guarantors/{guarantor_id}/requests/{request_id}/comments. Click here for further information.

Here is the API added in Q4 2022 for Debt Management:

  • Integrate Cash Facility Balances: /api/debt/v3/{account_code}/integrations/cash_facility_balance. Click here for further information.

WARNING: API deprecation announcement starting Q4 2022

Here below is the list of the APIs which are deprecated in Q4 2022. However, these remain fully supported until Q4 2023.

  • /api/debt/v3/{account_code}/integrations/xml-v3
  • /api/debt/v3/{account_code}/integrations/xml-v2
  • /api/debt/v3/{account_code}/integrations/xml-v1

As a reminder, the current version of the same API is as follows: /api/debt/v3/{account_code}/integrations

WARNING: APIs reaching end of deprecation cycle - Subject to removal without further notice

Here below is the list of long deprecated APIs. These are subject to removal without further notice:

  • /api/debt/v3/{account_code}/transactions
  • /api/debt/v3/{account_code}/transactions/{transaction_id}
  • /api/debt/v4/{account_code}/transactions/{transaction_id}/cash-flows
  • /api/debt/v3/{account_code}/cash-flows
  • /api/debt/v3/{account_id}/indicators/spot
  • /api/debt/v3/{account_id}/indicators/periodic
  • /api/referential/v3/{account_code}/users/{user_id}/accounts
  • /api/referential/v3/{account_code}/organizations (GET)
  • /api/referential/v3/{account_code}/organizations/{organization_id} (GET)
  • /api/referential/v3/{account_code}/entities/{entity_id} (GET)
  • /api/referential/v3/{account_code}/organizations/{organization_id}/entities (GET)
  • /api/referential/v3/{account_code}/entities (GET)

As a reminder, the current versions of the same APIs are as follows:

  • /api/debt/v4/{account_code}/transactions
  • /api/debt/v4/{account_code}/transactions/{transaction_id}
  • /api/debt/v5/{account_code}/transactions/{transaction_id}/cash-flows
  • /api/debt/v4/{account_code}/cash-flows
  • /api/debt/v4/{account_id}/indicators/spot
  • /api/debt/v4/{account_id}/indicators/periodic
  • /api/referential/v4/{account_code}/users/{user_id}/accounts
  • /api/referential/v4/{account_code}/organizations (GET)
  • /api/referential/v4/{account_code}/organizations/{organization_id} (GET)
  • /api/referential/v4/{account_code}/entities/{entity_id} (GET)
  • /api/referential/v4/{account_code}/organizations/{organization_id}/entities (GET)
  • /api/referential/v4/{account_code}/entities (GET)

 

 

Was this article helpful?
0 out of 0 found this helpful