Antom, leading provider of tailored payment solutions

notifyDispute

Antom 使用此接口向商户发送争议信息。

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息,有关报文头的结构信息,请参阅:
注意:将每个参数(除数组外)的数据类型设置为字符串,即参数的值必须使用英文双引号(" ")包裹起来。例如:
  • 如果参数的数据类型为整数属性,且其值为 20,设置为 "20"。
  • 如果参数的数据类型为布尔属性,且其值为 true,设置为 "true"。

入参

paymentRequestId String  REQUIRED

商户为识别支付请求而分配的专属 ID。

更多信息:

  • 最大长度:64 字符

disputeId String  REQUIRED

Antom 为识别争议而分配的争议 ID。

更多信息:

  • 最大长度:64 字符

paymentId String  REQUIRED

Antom 为识别支付而分配的支付 ID。

更多信息:

  • 最大长度:64 字符

disputeTime Datetime  

争议创建的日期和时间。

更多信息:

  • 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。

disputeAmount Amount  

存在争议的交易金额。
注意:当发生争议时返回此参数。

disputeNotificationType String  REQUIRED

争议通知的类型。有效值包括:
  • DISPUTE_CREATED: 表示发生了争议。
  • DISPUTE_JUDGED: 表示争议已被裁决。
  • DISPUTE_CANCELLED: 表示用户已取消争议。 
  • DEFENSE_SUPPLIED: 表示您已提交了争议的辩护文件。
  • DEFENSE_DUE_ALERT: Antom 发出的警告,通知您在 defenseDueTime 后的 24 小时内,您的辩护即将过期。
  • DISPUTE_ACCEPTED:表明争议已被受理。
  • RDR_RESOLVED : 表示争议是 RDR(Rapid dispute resolution)类型。

更多信息:

  • 最大长度:30 字符

disputeReasonMsg String  

争议的理由。

更多信息:

  • 最大长度:256 字符

disputeJudgedTime Datetime  

争议裁决的日期和时间。

更多信息:

  • 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。

disputeJudgedAmount Amount  

争议的扣款金额。
注意:当争议被裁决时返回此参数。

disputeJudgedResult String  

争议裁决结果。有效值为:
  • ACCEPT_BY_CUSTOMER:表示争议由客户负责。Antom解冻请款资金,您可以自由处理这笔资金。
  • ACCEPT_BY_MERCHANT:表示争议由商户负责。Antom解冻请款资金,但是会从您的结算账户中扣除以退还给买家。
  • VALIDATE_SUCCESS:表示合规调单材料上传后,材料验证成功。
  • VALIDATE_FAIL:表示合规调单材料上传后,材料验证失败。

更多信息:

  • 最大长度:30 字符

defenseDueTime Datetime  

您无法辩护争议的截止时间。
注意:当 disputeNotificationType 的值为DISPUTE_CREATED或DEFENSE_DUE_ALERT时,此参数返回。

disputeReasonCode String  

表明支付被争议的原因代码。有关原因代码的详细信息,请参阅拒付原因码。
注意:当 disputeNotificationType 的值为DISPUTE_CREATED或DISPUTE_JUDGED时,返回此参数。

更多信息:

  • 最大长度:64 字符

disputeSource String  

负责处理争议的银行卡组织。
注意:当 disputeNotificationType 的值为DISPUTE_CREATED或DISPUTE_JUDGED时,返回此参数。

更多信息:

  • 最大长度:64 字符

arn String  

争议的收单机构参考号(ARN)。
注意:当 disputeNotificationType 的值为DISPUTE_CREATED时,此参数返回。

更多信息:

  • 最大长度:64 字符

disputeAcceptReason String  

接受争议的原因。
当 disputeNotificationType 的值为 DISPUTE_ACCEPTED 时,请指定此参数。 有效值包括:
  • MERCHANT_ACCEPTED: 表示接受由商户发起的争议。
  • TIMEOUT: 表示由于超时场景而接受争议,即如果商户未能在指定时间内对争议进行抗辩,则争议将被自动接受。
  • MANUAL_PROCESSING_ACCEPTED: 表示由于手动处理而接受争议。

disputeAcceptTime Datetime  

争议被接受的时间。
注意:当 disputeNotificationType 的值为 DISPUTE_ACCEPTED时,请指定此参数。

disputeType String  REQUIRED

争议类型。有效值包括:
  • CHARGEBACK:表明争议类型为拒付争议;
  • RETRIEVAL_REQUEST:表明争议类型为调单争议。
  • ​COMPLIANCE_REQUEST:表明争议类型为合规调单争议。

更多信息:

  • 最大长度:64 字符

defendable Boolean  

表明争议是否可辩护。有效值为:
  • true:指示争议是可辩护的,此次拒付需要您来处理。
  • false:指示争议不可辩护,此次拒付后续将由 Antom 处理。

captureId String  

Antom 为识别请款分配的专属ID。
注意:如果存在多次请款,请指定此字段以关联相应的争议通知请求。

更多信息:

  • 最大长度:64 字符

autoDefendReason String  

自动抗辩原因。
注意:当 defendable的值为false 时,且发生拒付时,此参数有值。

更多信息:

  • 最大长度:256 字符

disputeCancelledTime Datetime  

争议被取消的日期和时间。
注意:仅当 disputeNotificationType 为 DISPUTE_CANCELLED 时返回;其他通知类型不返回。

更多信息:

  • 最大长度:32 字符
  • 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。

defenseSuppliedTime Datetime  

争议抗辩材料提交完成的日期和时间。
注意:仅当 disputeNotificationType 为 DEFENSE_SUPPLIED 时返回;其他通知类型不返回。

更多信息:

  • 最大长度:32 字符
  • 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。

出参

result Result  REQUIRED

发送给 Antom 以确认已收到通知的固定值。
API Explorer

请求

Case
json
{
  "disputeAmount": {
    "currency": "EUR",
    "value": "1000"
  },
  "disputeId": "202209212501310115730104****",
  "disputeNotificationType": "DISPUTE_CREATED",
  "defenseDueTime": "2023-09-20T23:41:32-07:00",
  "disputeTime": "2022-09-20T23:41:32-07:00",
  "disputeReasonCode": "4853",
  "disputeSource": "Mastercard",
  "paymentId": "202209231540108001001888XXXXXX****",
  "paymentRequestId": "requestId_12345****",
  "defendable": true
}

响应

json
{
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "success",
    "resultStatus": "S"
  }
}

结果处理逻辑

在收到 Antom 通知后,发送以下固定值的消息给 Antom,以确认收到 Antom 的通知:
json
{
 "result": {
    "resultCode":"SUCCESS",
    "resultStatus":"S",
    "resultMessage":"success"
 }
}
如果由于操作问题或网络问题没有将此类消息返回给 Antom,Antom 会反复发送通知,直到商家返回所需消息。首次通知发送后的 24 小时内会进行重试。通知将重试最多八次,间隔为 0 秒, 2 分钟, 10 分钟, 10 分钟, 1 小时, 2 小时, 6 小时, 和 15 小时。
注意:沙箱环境中,如果您没有按照固定格式返回信息,Antom 将不会重新发送异步通知给您。

结果码

结果码值结果码信息行动建议
SUCCESSS成功。
无需进一步操作。