Interest
Interest is the amount of money paid by a bank to its customers for keeping their funds in deposit accounts. The interest rate is set by the bank and is applied to the balance of the deposit account at the end of each day.
Accrued Interest
- Accrued interest represents the interest that accumulates on a financial instrument, such as a deposit account, over a specific period but has not yet been paid.
- When interest accrues daily, it means that the interest amount is calculated and added to the total owed or earned every day based on the account balance and the applicable interest rate.
- Unit uses the Daily Balance method to calculate interest. This means that interest is calculated and accrued daily based on the end of day balance but is paid once a month (typically happens around the first day of the month following the one in which the interest was accrued).
The response to this API call includes the sum of customer accrued interest (in cents) for a given period of time.
| Verb | GET |
| Url | https://api.s.unit.sh/accrued-interest/total |
| Required Scope | accounts |
| Timeout (Seconds) | 5 |
Query Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| filter[accountId] | string | (empty) | Optional. Filters the results by the specified account id. |
| filter[since] | RFC3339 Date string | (empty) | Optional. Filters the accrued interest after the specified date. e.g. 2024-01-13T16:01:19.346Z |
| filter[until] | RFC3339 Date string | (empty) | Optional. Filters the account accrued interest before the specified date. e.g. 2024-05-06T16:01:00.123Z |
| filter[sinceInterestMonth] | ISO8601 Year-Month string | (empty) | Optional. Filters the accrued interest after the specified month. e.g. 2024-03 |
| filter[untilInterestMonth] | ISO8601 Year-Month string | (empty) | Optional. Filters the accrued interest before the specified month. e.g. 2024-07 |
note
Either a set of [since] & [until] OR a set of [sinceInterestMonth] & [untilInterestMonth] is required.
Response
Response is a JSON:API document.
200 OK
| Field | Type | Description |
|---|---|---|
| data | Total Accrued Interest | The requested resource after the operation was completed. |
curl -X GET 'https://api.s.unit.sh/accrued-interest/total' \
-H "Authorization: Bearer ${TOKEN}"