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.
For simplicity, here below is the list of APIs that will reach end of support on September 30th, 2022.
|
Listing transactions |
/api/debt/v3/{account_code}/transactions |
|
Retrieving a transaction |
/api/debt/v3/{account_code}/transactions/{transaction_id} |
|
Listing cash flows on a set of transactions |
/api/debt/v3/{account_code}/cash-flows |
|
Spot indicators |
/api/debt/v3/{account_id}/indicators/spot |
|
Periodic Indicators |
/api/debt/v3/{account_id}/indicators/periodic |
|
|
|
|
Listing organizations |
/api/referential/v3/{account_code}/organizations |
|
Retrieving an organization |
/api/referential/v3/{account_code}/organizations/{organization_id} |
|
Retrieving the entities of an organization |
/api/referential/v3/{account_code}/organizations/{organization_id}/entities |
|
Listing entities |
/api/referential/v3/{account_code}/entities |
|
Retrieving an entity |
/api/referential/v3/{account_code}/entities/{entity_id} |
|
Listing the accounts of a user |
/api/referential/v3/{account_code}/users/{user_id}/accounts |
|
|
|
|
Listing cash flows on a transaction |
/api/debt/v3/{account_code}/transactions/{transaction_id}/cash-flows |
|
Listing cash flows on a transaction |
/api/debt/v4/{account_code}/transactions/{transaction_id}/cash-flows |