For the complete documentation index, see llms.txt. This page is also available as Markdown.

Payout订单状态回调通知

此 Webhook 用于 接收Payout订单的状态更新通知。您需提供 Webhook URL集成支持团队 (Integration Support Team) 进行配置,以确保回调通知能够 稳定、准确地传递

Webhook URL 旨在帮助您 实时获取 Payout 订单状态更新,请确保提供正确的 URL 以便 集成支持团队 进行配置,确保通知正常接收。

Webhook headers

Header
内容

x-signature

用于执行完整性检查的x-signature。

有关如何生成 x-signature 的更多详细信息,请参阅相关说明。

Content-Type

Content-Type始终为 application/json

Webhook payload

Header
描述

payout_id

由Coda创建的payout唯一ID。

request_id

由商户创建的、附加到payout请求的唯一请求 ID。

request_amount

Payout请求的总金额。

target_amount

支付给收款人的最终总金额(扣除费用、消费税、各种税费后的金额,具体取决于商户与 Coda 的合同)。

注意:request_amount 和 target_amount 可以是不同的货币

payout_status

此交易的payout状态。请参阅Payout状态表以了解不同状态。

error

如果出现错误,此处将显示错误信息。

通知payload示例

{
    "payout_id": "MDAwLjAuMTY4MDAxMjM3MC4xMw==",
    "request_id": "request_id",
    "request_amount": {
        "value": 10.0,
        "currency_code": "USD"
    },
    "target_amount": {
        "value": 10.0,
        "currency_code": "PHP"
    },
    "payout_status": {
        "code": "success",
        "message": "Payout is successful"
    },
    "error": null
}
{
    "payout_id": "MDAwLjAuMTY4MDAxMjM3MC4xMw==",
    "request_id": "request_id",
    "request_amount": {
        "value": 10.0,
        "currency_code": "USD"
    },
    "target_amount": {
        "value": 10.0,
        "currency_code": "PHP"
    },
    "payout_status": {
        "code": "Failed",
        "message": "Payout has failed, refer to the error message for more details."
    },
    "error": {
      "code": "INCOMPLETE_DATA",
        "message": "Data sent are incomplete and the request cannot be completed."
    }
}

最后更新于

这有帮助吗?