GET///
Returns a paginated list of interest tiers.
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of interest tiers to retrieve. Allowable Values: 0 min Default value: 5 |
| start_index integer Optional | Index of the first result in the returned array. Use for pagination. Allowable Values: 0 min Default value: 0 |
| sort_by string Optional | Field on which to sort. Prefix with - for descending order.Allowable Values: created_time, -created_time, last_modified_time, or -last_modified_timeDefault value: -created_time |
Response body
| Fields | Description |
|---|---|
| count integer Returned | Number of interest tier resources returned. Allowable Values: Example: 1 Any integer |
| start_index integer Returned | Sort order index of the first resource in the returned array. Allowable Values: Example: 0 Any integer |
| is_more boolean Returned | A value of true indicates that more unreturned resources exist.Allowable Values: Example: falsetrue, false |
| data array of objects Returned | Array of interest tier objects. Allowable Values: Valid array of one or more interest tier objects |
| data[].token string Returned | Unique identifier of the interest tier. Allowable Values: Example: 3f5e1b2a-8d4c-4e9b-a1f6-2c7d0e3b9a4536 char max |
| data[].description string Returned | Human-readable description of the interest tier. Allowable Values: Example: Premium savings tier with higher interest rates. 255 char max |
| data[].name string Returned | Display name of the interest tier. Allowable Values: Example: Premium Savings 255 char max |
| data[].type string Returned | Account type associated with the interest tier. Allowable Values: CHECKING, SAVINGS |
| data[].current_rate object Conditionally returned | The most recent rate with an effective date on or before today. Not included in responses from the create interest tier endpoint. Always present in retrieve and list responses. Allowable Values: note, account_rate, effective_rate, effective_date, created_time, updated_time |
| data[].current_rate.note string Conditionally returned | Optional note describing the reason for the rate change. Allowable Values: Example: Q3 2026 rate adjustment. 255 char max |
| data[].current_rate.account_rate decimal Conditionally returned | The gross interest rate, also known as the nominal interest rate. This is the base rate, calculated without compounding. Allowable Values: 0–100 |
| data[].current_rate.effective_rate decimal Conditionally returned | The effective interest rate, also known as the annual percentage yield (APY) or annual equivalent rate (AER) — the daily compounding rate applied to the account’s balance. Allowable Values: 0–100 |
| data[].current_rate.effective_date string Conditionally returned | Date the rate takes effect. Allowable Values: Format: yyyy-MM-dd |
| data[].current_rate.created_time datetime Conditionally returned | Date and time when the rate was created, in UTC. Allowable Values: Example: 2026-01-15T09:00:00Z Format: yyyy-MM-ddThh:mm:ssZ |
| data[].current_rate.updated_time datetime Conditionally returned | Date and time when the rate was last updated, in UTC. Allowable Values: Example: 2026-06-01T12:00:00Z Format: yyyy-MM-ddThh:mm:ssZ |
| data[].default boolean Returned | A value of true indicates this is the default tier for its account type.Allowable Values: Example: truetrue, false |
| data[].created_time datetime Returned | Date and time when the interest tier was created, in UTC. Allowable Values: Example: 2026-01-15T09:00:00Z Format: yyyy-MM-ddThh:mm:ssZ |
| data[].updated_time datetime Returned | Date and time when the interest tier was last updated, in UTC. Allowable Values: Example: 2026-06-01T12:00:00Z Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"count": 2,
"start_index": 0,
"is_more": false,
"data": [
{
"token": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"name": "Standard Checking",
"description": "Standard interest tier for checking accounts.",
"type": "CHECKING",
"default": true,
"created_time": "2026-01-15T09:00:00Z",
"updated_time": "2026-06-01T12:00:00Z",
"current_rate": {
"account_rate": 3.75,
"effective_rate": 3.82,
"effective_date": "2026-07-01",
"created_time": "2026-06-01T12:00:00Z",
"updated_time": "2026-06-01T12:00:00Z"
}
},
{
"token": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Premium Savings",
"description": "Premium savings tier with higher interest rates.",
"type": "SAVINGS",
"default": true,
"created_time": "2026-01-15T09:00:00Z",
"updated_time": "2026-06-01T12:00:00Z",
"current_rate": {
"account_rate": 4.5,
"effective_rate": 4.6,
"effective_date": "2026-07-01",
"created_time": "2026-06-01T12:00:00Z",
"updated_time": "2026-06-01T12:00:00Z"
}
}
]
}
Error codes
| Error Code | Error Message |
|---|---|
400001 | Invalid input(s) detected |