事件分组事件标识
paymentspayments/create
当争议事件被创建时触发。
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8
  • X-Shopline-Topic string required
    事件的唯一标识。
    例子: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    该请求的签名。收到请求后,你需要对该签名进行 验签 以验证数据的真实性和完整性。
    例子: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    店铺的域名。
    例子: example.myshopline.com
  • X-Shopline-Shop-Id string required
    店铺 ID。
    例子: 1610418123456
  • X-Shopline-Merchant-Id string required
    商家 ID。
    例子: 2000001234
  • X-Shopline-API-Version string required
    API 版本号。
    例子: v20250601
  • X-Shopline-Webhook-Id string required
    该 Webhook 事件的 ID。
    例子: b54557e48a5fbf7d70bcd043
请求体
  • detailobject
    争议详情。
  • amount string
    争议金额。数值保留到小数点后两位。
  • channel_dispute_id string
    SHOPLINE Payments 所使用的支付渠道的争议单号。
  • create_time string
    争议记录创建时间。格式:ISO 8601
    例子: 2025-06-01T00:00:00+08:00
  • currency string
    争议币种。该字段值为三位币种码,遵循 ISO 4217 国际标准,例如 CNY
  • dispute_evidence_update_deadline string
    商家提交抗辩资料的截止时间。格式:ISO 8601
    例子: 2025-06-02T00:00:00+08:00
  • dispute_id string
    争议记录的唯一标识。
  • dispute_type string
    争议类型。有效枚举值包含:
    • CHARGEBACK:买家向其银行发起交易争议,争议金额将被银行暂扣。
    • PRE_CHARGEBACK:这表示在完整 CHARGEBACK 之前的一个初步阶段。发卡银行正在调查争议。
    • RETRIEVAL:收单方要求商家提供有关该交易的更多信息。
    • FRAUD_NOTIFICATION:该交易可能存在欺诈风险。
  • exchangeobject
    换汇信息。
  • amount string
    基于实际支付金额进行换汇的金额。数值保留到小数点后两位。
  • currency string
    兑换币种。该字段值为三位币种码,遵循 ISO 4217 国际标准,例如 CNY
  • rate string
    换汇汇率。格式为 {争议币种}/{兑换币种} @{汇率},汇率值保留到小数点后 10 位。
    例子: USD/USD @1.0000000000
  • fee string
    手续费。SHOPLINE Payments 收取商家手续费则显示为负,SHOPLINE Payments 退还商家手续费则显示为正。
  • fee_type string
    手续费类型。有效枚举值包含:
    • domestic:本地交易手续费,接受国内银行卡片刷卡时的手续费。
    • international:跨境交易手续费,接受国外银行卡片刷卡时的手续费。
  • payment_method string
    支付方式。
  • reason string
    争议的原因。
    dispute_typeCHARGEBACK 时,reason 的枚举值为:
    • fraudulent:欺诈交易。
    • unrecognized:不明交易。
    • duplicate:买家重复支付。
    • subscription canceled:买家取消交易。
    • product not received:买家未收到商品。
    • product unacceptable:买家对商品不满意。
    • credit not processed:买家未收到退款。
    • general:其他原因。
    dispute_typePRE_CHARGEBACKRETRIEVALFRAUD_NOTIFICATION 时,reason 的值为非枚举值。
  • seller_order_id string
    业务订单号。
  • status string
    争议事件的状态。
    dispute_typeCHARGEBACK 时,有效枚举值为:
    • CREATED:争议已创建。
    dispute_typePRE_CHARGEBACK 时,有效枚举值为:
    • PRE_CHARGEBACK_CREATED:预拒付已创建。在某些卡种下,系统没有协助进行自动退款,需要商家手动选择是否接受退款。
    dispute_typeRETRIEVAL 时,有效枚举值为:
    • RETRIEVAL_CREATED:调单发起。
    dispute_typeFRAUD_NOTIFICATION 时,有效枚举值为:
    • FRAUD_FINISHED:欺诈预警。建议商家先不发货并和买家商议,确认是不是真实的下单。如有必要可以退款。否则可能会变为拒付。
  • trade_order_id string
    原始支付订单的唯一标识。
  • update_time string
    争议记录更新时间。格式:ISO 8601。当与此争议关联信息(如交易状态)更新时,此时间也会被更新。
    例子: 2025-06-01T00:00:00+08:00
  • event_id string
    争议事件的唯一标识,以此作为幂等判断,避免重复处理。
  • event_type string
    事件类型。固定值:slp_dispute/create
  • store_id string
    店铺 ID。
状态码
收到 SHOPLINE 发送的 Webhook 通知后,你需要按照如下 SHOPLINE 要求的格式进行响应。
HTTP/1.1 200 OK
关于如何订阅 Webhooks 及更多 Webhook 响应规则说明,请参考 Webhook 概述
这篇文章对你有帮助吗?