Skip to content

代付 Webhook

代付状态异步通知。

接口

POST /callback_url

认证

Merchant Credential。详见 认证

重要说明

警告

该接口的响应时间请务必在3s内响应,如超3s响应,系统将当做回调失败处理!

请求头

名称位置类型必填说明示例
Content-Typeheaderstringapplication/json
X-Nonceheaderstringa9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-Idheaderstring2492265300
X-Timestampheaderstring1638123456
DigestheaderstringSHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
AuthorizationheaderstringSignature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

请求体

字段类型必填说明
mchOrderNostring商户订单号
platOrderNostring平台订单号
orderStatusstring订单状态 (enum=PENDING, SUCCESS, FAILED, REFUND)
amountnumber到账金额
feenumber手续费
toPixstring
toIspbstring
toNamestring
fromBankstring
fromCnpjstring
fromNamestring
toCpfCnpjstring
ispbNamestring
msgstring信息 — 错误信息
eventstring事件 (enum=PIX_OUT_SUCCESS, PIX_OUT_FAILED, PIX_OUT_REFUND)
payTimenumber
e2eIdstring

请求示例

json
{
  "event": "PIX_OUT_SUCCESS",
  "mchOrderNo": "payout_1662104438",
  "platOrderNo": "wussXUCOoXO3yptr7rQV",
  "orderStatus": "PENDING",
  "e2eId": "E20259930123438389IOs9ewKop39s",
  "payTime": 1669080985,
  "amount": 180.34,
  "fee": 200.36,
  "toPix": "47***112",
  "toIspb": "22896431",
  "toName": "SEBASTIAO CONCEICAO SANTOS",
  "fromBank": "Adox IP",
  "fromCnpj": "***.820.307/0002**",
  "fromName": "DX MEIOS DE PAGAMENTOS LTDA",
  "toCpfCnpj": "473******53",
  "ispbName": "-"
}

响应

HTTP 200 — 成功