{ "opencollection": "1.0.0", "info": { "name": "API Reference Accounts pricingGroups API", "version": "1.0.0" }, "items": [ { "info": { "name": "pricingGroups", "type": "folder" }, "items": [ { "info": { "name": "List Pricing Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.modernfi.com/digital-banking/v1/pricing-groups", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "List all pricing groups for the institution, including account counts and current rate tiers." }, { "info": { "name": "Create Pricing Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.modernfi.com/digital-banking/v1/pricing-groups", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get Pricing Group", "type": "http" }, "http": { "method": "GET", "url": "https://api.modernfi.com/digital-banking/v1/pricing-groups/:pricing_group_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "pricing_group_id", "value": "", "type": "path" } ] }, "docs": "Retrieve details for a specific pricing group, including its rate tiers and account count." }, { "info": { "name": "Update Pricing Group Metadata", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.modernfi.com/digital-banking/v1/pricing-groups/:pricing_group_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "pricing_group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update pricing group name and/or description. This endpoint does not affect rates or account assignments. Use PUT /pricing-groups/{id}/rates to update rates." }, { "info": { "name": "Delete Pricing Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.modernfi.com/digital-banking/v1/pricing-groups/:pricing_group_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "pricing_group_id", "value": "", "type": "path" } ] }, "docs": "Delete a pricing group. This operation will fail if any accounts are currently assigned to this pricing group. Unassign accounts first before deleting." }, { "info": { "name": "Update Pricing Group Rates", "type": "http" }, "http": { "method": "PUT", "url": "https://api.modernfi.com/digital-banking/v1/pricing-groups/:pricing_group_id/rates", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "pricing_group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the rate tiers for a pricing group. The new rates will automatically cascade to all accounts assigned to this pricing group on the specified effective date. This creates a new rate tier version while preserving historical rate data." }, { "info": { "name": "Assign Accounts To Pricing Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.modernfi.com/digital-banking/v1/pricing-groups/:pricing_group_id/accounts", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "pricing_group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign multiple accounts to a pricing group. The pricing group's current rate structure will be copied to all assigned accounts. If accounts are already assigned to a different pricing group, they will be reassigned and receive the new rates." }, { "info": { "name": "Unassign Accounts From Pricing Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.modernfi.com/digital-banking/v1/pricing-groups/:pricing_group_id/accounts", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "pricing_group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unassign multiple accounts from a pricing group. Accounts will retain their current rates but will no longer receive automatic updates when the pricing group rates change. Future rate changes for these accounts must be made individually or by assigning them to a different pricing group." } ] } ], "bundled": true }