> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.modernfi.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.modernfi.com/_mcp/server. # Create Pricing Group POST https://api.modernfi.com/digital-banking/v1/pricing-groups Content-Type: application/json Create a new pricing group with rate tiers. Pricing groups allow institutions to manage interest rates at scale by defining reusable rate structures that can be assigned to multiple accounts. When a pricing group's rates are updated, all assigned accounts receive the new rates automatically. Reference: https://docs.modernfi.com/api-reference/pricing-groups/create ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api.modernfi.com` (Production, default) - `https://api.uat.modernfi.com` (UAT) - `http://localhost:8000` (Local) ## Request ### Body (application/json) This endpoint expects a CreatePricingGroupRequest. - `name` (string, required) — Name of the pricing group (e.g., 'Retail Checking', 'Accounts 2025') - `interest_rate_tiers` (list of PricingGroupRateTierRequest, required) — Rate tiers for the pricing group. At least one tier is required. - `description` (string, optional, nullable) — Optional description providing additional context about this pricing group - `effective_at` (string, optional) — When these rates become effective. Defaults to now if not provided. - `account_ids` (list of string, optional, nullable) — Optional list of account IDs to assign to this pricing group upon creation. If provided, the pricing group rates will be applied to these accounts immediately. ## Response ### 201 Successful Response - `id` (string, required) - `institution_id` (string, required) - `name` (string, required) - `description` (string, required, nullable) - `account_count` (integer, required) — Number of accounts currently assigned to this pricing group - `interest_rate_tiers` (list of PricingGroupRateTierResponse, required) - `created_at` (string, required) - `updated_at` (string, required) - `accounts` (list of AccountData, required) — List of accounts assigned to this pricing group ## Errors ### 400 Bad Request Error Bad Request - Invalid input or validation error - `detail` (list of map from string to any, required) ### 401 Unauthorized Error Unauthenticated - Invalid or missing authentication credentials - `detail` (string, required) ### 403 Forbidden Error Unauthorized - Insufficient permissions to access resource - `detail` (string, required) ### 422 Unprocessable Entity Error Validation Error - `detail` (list of ValidationError, optional) ### 500 Internal Server Error Internal Server Error - `detail` (string, required) ## Types ### PricingGroupRateTierRequest - `min_balance` (PricingGroupRateTierRequestMinBalance, required) — Minimum balance for this tier (inclusive) - `max_balance` (PricingGroupRateTierRequestMaxBalance, required) — Maximum balance for this tier (inclusive) - `rate` (PricingGroupRateTierRequestRate, optional, nullable) — Fixed interest rate (e.g., 0.035 for 3.5%). Mutually exclusive with floating_spread. - `floating_spread` (PricingGroupRateTierRequestFloatingSpread, optional, nullable) — Floating spread relative to market reference rate (e.g., 0.005 for +0.5%). Mutually exclusive with rate. - `rate_index_type` (enum, optional, nullable) — Reference rate index type (e.g., EFFR). Required when floating_spread is set and custom_benchmark_id is not. Mutually exclusive with custom_benchmark_id. - Allowed values: `EFFR`, `CU_RECEIVE_DEFAULT`, `BANK_RECEIVE_DEFAULT`, `EFFR_UPPER_BAND`, `EFFR_LOWER_BAND`, `SOFR_OVERNIGHT`, `SOFR_1M`, `SOFR_3M`, `SOFR_6M`, `SOFR_12M`, `CMT_1M`, `CMT_3M`, `CMT_6M`, `FIDELITY_FISXX`, `FIDELITY_SPAXX`, `FIDELITY_FCIXX`, `WSJ_PRIME`, `IORB` - `floating_rate_percentage` (PricingGroupRateTierRequestFloatingRatePercentage, optional, nullable) — Multiplier applied to the index rate. Required when floating_spread is set. - `custom_benchmark_id` (string, optional, nullable) — Custom benchmark to float against. Mutually exclusive with rate_index_type. ### PricingGroupRateTierResponse - `min_balance` (string, required) - `max_balance` (string, required) - `rate` (string, optional, nullable) - `floating_spread` (string, optional, nullable) - `rate_index_type` (enum, optional, nullable) - Allowed values: `EFFR`, `CU_RECEIVE_DEFAULT`, `BANK_RECEIVE_DEFAULT`, `EFFR_UPPER_BAND`, `EFFR_LOWER_BAND`, `SOFR_OVERNIGHT`, `SOFR_1M`, `SOFR_3M`, `SOFR_6M`, `SOFR_12M`, `CMT_1M`, `CMT_3M`, `CMT_6M`, `FIDELITY_FISXX`, `FIDELITY_SPAXX`, `FIDELITY_FCIXX`, `WSJ_PRIME`, `IORB` - `floating_rate_percentage` (string, optional, nullable) - `custom_benchmark_id` (string, optional, nullable) ### AccountData - `id` (string, required) - `title` (string, required) ### ValidationError - `loc` (list of ValidationErrorLocItems, required) - `msg` (string, required) - `type` (string, required) - `input` (any, optional) - `ctx` (ValidationErrorCtx, optional) ### PricingGroupRateTierRequestMinBalance Minimum balance for this tier (inclusive) ### PricingGroupRateTierRequestMaxBalance Maximum balance for this tier (inclusive) ### PricingGroupRateTierRequestRate Fixed interest rate (e.g., 0.035 for 3.5%). Mutually exclusive with floating_spread. ### PricingGroupRateTierRequestFloatingSpread Floating spread relative to market reference rate (e.g., 0.005 for +0.5%). Mutually exclusive with rate. ### PricingGroupRateTierRequestFloatingRatePercentage Multiplier applied to the index rate. Required when floating_spread is set. ### ValidationErrorLocItems ### ValidationErrorCtx ## Examples **Request** ```json { "name": "Premium Savings Group", "interest_rate_tiers": [ { "min_balance": 0, "max_balance": 10000 }, { "min_balance": 10000.01, "max_balance": 50000 }, { "min_balance": 50000.01, "max_balance": 100000 } ] } ``` **Response** ```json { "id": "a3f1c9d2-4b7e-4f8a-9c2d-1e2f3a4b5c6d", "institution_id": "b7d9e8f0-1234-5678-9abc-def012345678", "name": "Premium Savings Group", "description": "Interest rate tiers for premium savings accounts with tiered rates based on balance.", "account_count": 42, "interest_rate_tiers": [ { "min_balance": "0.00", "max_balance": "10000.00", "rate": "0.015", "floating_spread": "null", "rate_index_type": "null", "floating_rate_percentage": "null", "custom_benchmark_id": "null" }, { "min_balance": "10000.01", "max_balance": "50000.00", "rate": "0.020", "floating_spread": "null", "rate_index_type": "null", "floating_rate_percentage": "null", "custom_benchmark_id": "null" }, { "min_balance": "50000.01", "max_balance": "100000.00", "rate": "0.025", "floating_spread": "null", "rate_index_type": "null", "floating_rate_percentage": "null", "custom_benchmark_id": "null" } ], "created_at": "2024-06-01T09:00:00Z", "updated_at": "2024-06-01T09:00:00Z", "accounts": [ { "id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70", "title": "John Doe Savings Account" }, { "id": "e7f8a9b0-c1d2-3e4f-5a6b-7c8d9e0f1a2b", "title": "Jane Smith Premium Savings" } ] } ``` **SDK Code** ```python import requests url = "https://api.modernfi.com/digital-banking/v1/pricing-groups" payload = { "name": "Premium Savings Group", "interest_rate_tiers": [ { "min_balance": 0, "max_balance": 10000 }, { "min_balance": 10000.01, "max_balance": 50000 }, { "min_balance": 50000.01, "max_balance": 100000 } ] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.modernfi.com/digital-banking/v1/pricing-groups'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"name":"Premium Savings Group","interest_rate_tiers":[{"min_balance":0,"max_balance":10000},{"min_balance":10000.01,"max_balance":50000},{"min_balance":50000.01,"max_balance":100000}]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.modernfi.com/digital-banking/v1/pricing-groups" payload := strings.NewReader("{\n \"name\": \"Premium Savings Group\",\n \"interest_rate_tiers\": [\n {\n \"min_balance\": 0,\n \"max_balance\": 10000\n },\n {\n \"min_balance\": 10000.01,\n \"max_balance\": 50000\n },\n {\n \"min_balance\": 50000.01,\n \"max_balance\": 100000\n }\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.modernfi.com/digital-banking/v1/pricing-groups") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"Premium Savings Group\",\n \"interest_rate_tiers\": [\n {\n \"min_balance\": 0,\n \"max_balance\": 10000\n },\n {\n \"min_balance\": 10000.01,\n \"max_balance\": 50000\n },\n {\n \"min_balance\": 50000.01,\n \"max_balance\": 100000\n }\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.modernfi.com/digital-banking/v1/pricing-groups") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"name\": \"Premium Savings Group\",\n \"interest_rate_tiers\": [\n {\n \"min_balance\": 0,\n \"max_balance\": 10000\n },\n {\n \"min_balance\": 10000.01,\n \"max_balance\": 50000\n },\n {\n \"min_balance\": 50000.01,\n \"max_balance\": 100000\n }\n ]\n}") .asString(); ``` ```php request('POST', 'https://api.modernfi.com/digital-banking/v1/pricing-groups', [ 'body' => '{ "name": "Premium Savings Group", "interest_rate_tiers": [ { "min_balance": 0, "max_balance": 10000 }, { "min_balance": 10000.01, "max_balance": 50000 }, { "min_balance": 50000.01, "max_balance": 100000 } ] }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.modernfi.com/digital-banking/v1/pricing-groups"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"Premium Savings Group\",\n \"interest_rate_tiers\": [\n {\n \"min_balance\": 0,\n \"max_balance\": 10000\n },\n {\n \"min_balance\": 10000.01,\n \"max_balance\": 50000\n },\n {\n \"min_balance\": 50000.01,\n \"max_balance\": 100000\n }\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "name": "Premium Savings Group", "interest_rate_tiers": [ [ "min_balance": 0, "max_balance": 10000 ], [ "min_balance": 10000.01, "max_balance": 50000 ], [ "min_balance": 50000.01, "max_balance": 100000 ] ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.modernfi.com/digital-banking/v1/pricing-groups")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```