POST///
Creates a new interest tier for a program’s checking or savings accounts.
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the interest tier. If not provided, one is generated automatically. Allowable Values: 1–36 chars |
| description string Required | Human-readable description of the interest tier. Allowable Values: Example: Premium savings tier with higher interest rates. 255 char max |
| name string Required | Display name of the interest tier. Allowable Values: Example: Premium Savings 255 char max |
| type string Required | Account type associated with the interest tier. Allowable Values: CHECKING, SAVINGS |
| default boolean Required | A value of true indicates this is the default tier for its account type.Allowable Values: Example: truetrue, false |
Sample request body
Create a checking interest tierJSON
{
"token": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"name": "Standard Checking",
"description": "Standard interest tier for checking accounts.",
"type": "CHECKING",
"default": true
}
JSON
{
"token": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Premium Savings",
"description": "Premium savings tier with higher interest rates.",
"type": "SAVINGS",
"default": true
}
Response body
| Fields | Description |
|---|---|
| token string Returned | Unique identifier of the interest tier. Allowable Values: Example: 3f5e1b2a-8d4c-4e9b-a1f6-2c7d0e3b9a4536 char max |
| description string Returned | Human-readable description of the interest tier. Allowable Values: Example: Premium savings tier with higher interest rates. 255 char max |
| name string Returned | Display name of the interest tier. Allowable Values: Example: Premium Savings 255 char max |
| type string Returned | Account type associated with the interest tier. Allowable Values: CHECKING, SAVINGS |
| 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 |
| 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 |
| 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 |
| 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 |
| current_rate.effective_date string Conditionally returned | Date the rate takes effect. Allowable Values: Format: yyyy-MM-dd |
| 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 |
| 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 |
| default boolean Returned | A value of true indicates this is the default tier for its account type.Allowable Values: Example: truetrue, false |
| 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 |
| 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
Checking tier createdJSON
{
"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-01-15T09:00:00Z"
}
JSON
{
"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-01-15T09:00:00Z"
}
Error codes
| Error Code | Error Message |
|---|---|
400001 | Invalid input(s) detected |
500000 | Internal server error |