配置 Webhooks
概述
Webhook URL 只能在面板中注册(https://banking.fypay.me),位于 设置 → Webhooks(Configurações → Webhooks)。没有用于注册、列出或删除 webhooks 的 API 端点,也没有用于生成签名密钥的 API 端点。
Webhook 配置的更改会立即生效。 后续事件将使用已配置的 URL。
注册 webhook
登录 https://banking.fypay.me,打开 设置 → Webhooks。
选择该 URL 要接收的事件类型:
cash_in- 收到 PIXcash_out- 发送 PIXrefund_in- 收款冲正refund_out- 收到退款med_created- 针对已收到交易发起的 MED(特殊退款机制)med_accepted- MED 退款请求已批准med_rejected- MED 退款请求已拒绝
填写您的端点 URL。必须使用 HTTPS(不接受 HTTP),且必须是有效的公网 URL(私有或内部地址会被拒绝)。
示例: https://api.example.com/webhooks/pix
最多注册 5 个 headers,它们会随发往该 URL 的每个 webhook 一起发送。可用于在您的端点验证调用(例如 Authorization 或 X-Webhook-Secret)。
- Header 名称:只能包含字母、数字、
-和_ - Header 值:不能为空
- 禁止的 headers:
host、content-length、connection、transfer-encoding、content-type、user-agent
定义交易事件发往该 URL 的 payload 格式:
- 标准(默认值):本 Webhooks 章节描述的格式
- PIX BACEN:PIX BACEN 标签页中的格式
MED 事件始终使用相同的 payload,与版本无关。
在同一菜单中生成 HMAC 签名密钥。此后每个 webhook 都会携带 X-Avista-Signature header,您应在端点中验证它。生成、轮换和验证的详细步骤请参阅 实现。
每个事件多个 URL
同一事件最多可注册 3 个有效的 HTTPS URL。注册新的 URL 会将其添加到该事件;已注册的 URL 保持有效,不会被替换。
事件发生时,通知会以 fan-out 方式发送到该事件下所有有效的 URL。每个 URL 有独立的投递和重试:一个 URL 失败不会影响其他 URL。
如需编辑某个 URL 的 headers 或版本,或删除它以释放 3 个名额中的空间,请使用同一个 设置 → Webhooks 菜单。
配置多个事件
如需接收多种事件类型的通知,请在面板中为每个所需事件注册该 URL。
您可以为所有事件类型使用同一个 URL,并通过 webhook payload 中的 event 字段进行区分。