配置账户 webhook
为特定事件类型配置或更新 webhook URL。如果同一事件类型已存在 webhook,将进行更新(upsert 行为)。
需要在 Authorization 头中提供 Bearer 令牌。
| 事件 | 描述 |
|---|
cash_in | 收到 PIX 付款 |
cash_out | 发送 PIX 付款 |
refund_in | 已收付款的退款(发起退款请求) |
refund_out | 收到退款 |
| 字段 | 类型 | 必填 | 描述 |
|---|
url | string | 是 | 接收 webhooks 的端点 HTTPS URL |
eventType | string | 是 | 事件类型:cash_in、cash_out、refund_in、refund_out |
headers | array | 否 | 用于身份验证的自定义请求头(最多 5 个)。禁用的请求头:host、content-length、connection、transfer-encoding、content-type、user-agent |
headers[].key | string | 是 | 请求头名称 |
headers[].value | string | 是 | 请求头值 |
{
"url": "https://api.example.com/webhooks/pix",
"eventType": "cash_in",
"headers": [
{ "key": "Authorization", "value": "Bearer token123" },
{ "key": "X-Webhook-Secret", "value": "abc123" }
]
}
| 字段 | 类型 | 描述 |
|---|
success | boolean | 表示操作是否成功 |
message | string | 结果描述信息 |
{
"success": true,
"message": "Webhook configurado com sucesso"
}
| 状态码 | 描述 |
|---|
| 400 | 数据无效(URL 非 HTTPS、事件类型无效等) |
| 401 | 令牌缺失或无效 |
| 404 | 账户未找到 |
| 500 | 配置 webhook 时内部错误 |