📄 正文
一个主体可以同时被多条规则约束,系统在每个维度上取最严值合并出「有效限额」。query-quota 返回的就是这份合并结果与当期已用,剩余额度平台已代为算出;规则本身的调整走 update-rule(全量替换)与 change-rule-status(启停),查阅走 query-rule 与 list-rules。规则创建见创建限额规则,合并模型的概念主线见限额与账单。
查询有效额度
GET /open-api-corp/velocity/v1/query-quota——查某主体(卡 / 员工)合并后的有效限额与当期已用。
请求参数(Query String)
额度对象:读懂响应的钥匙
响应里每个周期节点(daily / monthly / quarterly / yearly)都是一个「额度对象」。金额侧与笔数侧字段名不同,结构一一对应:
单笔限额是例外:
perTransaction 额度对象只有 limitAmount 与 sourceRuleId 两个字段——单笔不累计,没有已用、剩余、使用率与周期键。响应 data 结构
响应示例
错误码
更新规则
POST /open-api-corp/velocity/v1/update-rule——全量替换:请求中未包含的维度 / 控制组即删除;对已绑定主体即时生效。
请求字段与创建规则的五个控制组完全一致,差别在顶层:
响应
data 为更新后的完整规则对象(结构与创建响应一致),其中 ruleVersion 已自增。
未配置的控制组返回
null 而不是空对象——空对象会让您误以为配了一个空名单。启停规则
POST /open-api-corp/velocity/v1/change-rule-status——在 ACTIVE ⇄ INACTIVE 间切换。INACTIVE 不参与任何交易校验,但保留既有绑定关系,重新启用即恢复约束,不需要逐个解绑。
响应
data:ruleId、ruleName(供客户端确认改对了规则)、status(变更后状态)、ruleVersion(变更后的新值,下次更新须用它)、bindingCount、modifyTime。
查规则详情与列表
详情:GET /open-api-corp/velocity/v1/query-rule——传 organizationId + ruleId,返回完整规则对象(结构与创建响应一致,含 ruleVersion、bindingCount 与五个控制组)。规则不存在或不属所传 organizationId 时返回 VELOCITY_RULE_NOT_FOUND。
列表:GET /open-api-corp/velocity/v1/list-rules——分页查询组织下的规则,只返摘要。
响应
data 为标准分页壳:page / pageSize / total + result[],每项含 ruleId、ruleName、status、bindingCount、modifyTime。
total 是数字,bindingCount 是字符串——后者声明为装箱 Long,经序列化器出参为字符串。解析时请分别处理。
