alerts.fx_rate.triggered —— 警报条件满足时的通知POST /v1/alerts 提交包含条件参数和到期日期的请求,创建警报。active_status: true)的警报实时监控 FX 汇率。DELETE /v1/alerts/{id} 停用警报,系统将把 active_status 设置为 false。valid_until 日期自动过期。alerts.fx_rate.triggered 后,将通过 Notifications API 接收警报通知。更多信息请参阅:通知与订阅metadata 对象包含警报配置信息,以及在适用时触发该警报的 FX 汇率。| 字段 | 说明 |
|---|---|
currency_pair | 被监控的货币对(例如 usd/cop、usd/mxn) |
condition | 警报条件类型:above、below 或 within_range |
max_rate | 最大汇率阈值(用于 above 和 within_range 条件) |
min_rate | 最小汇率阈值(用于 below 和 within_range 条件) |
fx_rate | 触发警报的实际 FX 汇率(仅存在于触发通知中) |
fx_rate 字段仅包含在 alerts.fx_rate.triggered Webhook 载荷中,表示警报条件满足时的市场汇率。current_rate > max_rate 时警报触发condition:"above"max_rate:数值型阈值{
"metadata": {
"condition": "above",
"currency_pair": "usd/cop",
"max_rate": 3500
}
}{
"type": "fx_rate",
"alias": "My Alert Name",
"metadata": {
"condition": "above|below|within_range",
"currency_pair": "usd/cop",
"max_rate": 3500,
"min_rate": 3400
},
"valid_until": "2026-12-31T23:59:59Z"
}| 字段 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
type | string | 是 | 必须为 "fx_rate" |
alias | string | 否 | 警报的友好名称 |
metadata.condition | string | 是 | 取值之一:above、below、within_range |
metadata.currency_pair | string | 是 | 需监控的货币对(例如 usd/cop) |
metadata.max_rate | number | 条件必填 | above 和 within_range 条件时必填 |
metadata.min_rate | number | 条件必填 | below 和 within_range 条件时必填 |
valid_until | string | 是 | ISO 8601 时间戳——警报到期日期 |
within_range 条件valid_until 日期,避免过期警报累积event_id 实施幂等性检查,以处理重复的 Webhook 投递fx_rate 值,供审计和决策使用alias 值,便于团队识别各警报updated_at 字段,追踪警报最后修改时间event_signature_key{
"type": "fx_rate",
"alias": "Execute Payment Window",
"metadata": {
"condition": "below",
"currency_pair": "usd/cop",
"min_rate": 4000
},
"valid_until": "2026-06-30T23:59:59Z"
}fx_rate: 3985.50 的 Webhook| 货币对 | 说明 |
|---|---|
usd/cop | 美元兑哥伦比亚比索 |
cop/usd | 哥伦比亚比索兑美元 |
usd/mxn | 美元兑墨西哥比索 |
mxn/cop | 墨西哥比索兑哥伦比亚比索 |
| HTTP 状态码 | 错误 | 解决方案 |
|---|---|---|
400 Bad Request | 无效的条件类型 | 请使用 above、below 或 within_range |
400 Bad Request | 缺少必填的汇率字段 | above 需包含 max_rate,below 需包含 min_rate,within_range 两者均需包含 |
400 Bad Request | 无效的货币对 | 请仅使用受支持的货币对 |
401 Unauthorized | 身份验证失败 | 请检查您的 API 凭证和授权请求头 |
404 Not Found | 警报 ID 不存在 | 请从您的警报列表中核实警报 ID |
422 Unprocessable Entity | 无效的 valid_until 日期 | 请确保日期为未来时间且格式正确 |
active_status: true,并具有唯一的警报 ID。alerts.fx_rate.created 的用户将立即收到通知。alerts.fx_rate.triggered 事件通知。/v1/alerts 发送 POST 请求,并填写所需条件及货币对。event_signature 请求头及订阅的 event_signature_key 对接收到的 Webhook 进行签名验证。fx_rate 值决定是否锁定汇率、执行支付或调整对冲策略。