API 端点
退款
退款是把您收到的 Pix 退回去。仅适用于已结算(status: COMPLETED)的入账交易(type: DEPOSIT)。
工作方式
传入 amount 可退回部分金额,省略该字段则退回全额。接口会立即返回,此时退款处于待处理状态:确认不是同步的。
返回 200 表示退款已被受理,不代表款项已经退回。请等待 status: REFUNDED 的 Webhook,再在您这边核销。
务必传 clientReference
clientReference 是退款的幂等键。不传的话,超时或网络错误后的重试会把钱退两次。
| 情况 | 结果 |
|---|---|
相同键、相同 amount | 返回已创建的退款,不会新建 |
相同键、不同 amount | 以 PZC210 拒绝 |
| 不传键 | 每次调用都会新建一笔退款 |
请用您自己的订单号生成该键(refund-order-2026-001),并在重试时复用同一个值。部分退款时,每一笔用一个独立的键。
示例
跟踪结果
退款字段会在回调和交易查询中返回:refundStatus、refundAmount、refundEndToEndId、refundReason 和 refundedAt。完整参考见 Webhook。