v1.6.2
See below for our latest API changes. This release introduces Custom Benchmarks and floating / indexed rates — you can now tie account and pricing-group rates to market reference rates (SOFR, EFFR, Prime, and more) or to your own custom benchmarks, instead of managing fixed rates by hand. We recommend reviewing this page closely before beginning development or upgrading to a new API version.
New Endpoints
Custom Benchmarks — Define and manage your own reference rates, then attach them to accounts and pricing-group rate tiers as a floating-rate index.
GET /digital-banking/v1/custom-benchmarks— List all custom benchmarks for your institution, including their current rates.POST /digital-banking/v1/custom-benchmarks— Create a custom benchmark with aname, optionaldescription, and an initialrate(decimal, e.g.0.0425for 4.25%).GET /digital-banking/v1/custom-benchmarks/{custom_benchmark_id}— Retrieve a single custom benchmark.PATCH /digital-banking/v1/custom-benchmarks/{custom_benchmark_id}— Update a benchmark’snameand/ordescription. Does not change its rate.PUT /digital-banking/v1/custom-benchmarks/{custom_benchmark_id}— Set a newrate, optionally as of a futureeffective_attimestamp. Accounts indexed to the benchmark update automatically, and historical rates are preserved.DELETE /digital-banking/v1/custom-benchmarks/{custom_benchmark_id}— Delete a custom benchmark.
Updated Endpoints
POST /digital-banking/v1/accounts(Create Account) andPATCH /digital-banking/v1/accounts/{account_id}(Update Account)- Accounts can now be opened or updated as floating-rate, indexed to a market reference rate or a custom benchmark. See the new
rate_configurationand rate-index fields onAccountResponsebelow.
- Accounts can now be opened or updated as floating-rate, indexed to a market reference rate or a custom benchmark. See the new
Schema Changes
-
AccountResponse— added rate-configuration fields:rate_configuration(RateConfigurationenum, required) — how the account’s rate is determined:FIXED,FLOATING_MARKET,FLOATING_CUSTOM, orTIERED.rate(string, nullable),index_rate(string, nullable), andrate_index_type(ReferenceRateType, nullable) — the resolved rate and, for floating accounts, the market index it tracks.custom_benchmark_id(uuid, nullable) andcustom_benchmark_rate(string, nullable) — the custom benchmark the account is indexed to, if any.floating_spread,floating_spread_bps, andfloating_rate_percentage(nullable) — the spread/percentage applied over the index.
-
InterestRateTierandPricingGroupRateTier(request & response)- Added
rate_index_type(ReferenceRateType, nullable),custom_benchmark_id(uuid, nullable), andfloating_rate_percentage(nullable) — rate tiers can now float against a market index or custom benchmark instead of being fixed.
- Added
-
New enums
RateConfiguration—FIXED,FLOATING_MARKET,FLOATING_CUSTOM,TIEREDReferenceRateType— market reference rates includingEFFR,SOFR_1M/SOFR_3M/SOFR_6M/SOFR_12M,CMT_3M,WSJ_PRIME, and Fidelity money-market rates
-
New schemas:
CreateCustomBenchmarkRequest,PatchCustomBenchmarkRequest,UpdateCustomBenchmarkRateRequest