1. 接入指引
Dispute Service API
  • Dispute API
    • 接入指引
      • Dispute Service 服务使用指引
      • 安全要求及报文格式
      • 特殊规则说明
    • 接口
      • Dispute
        • Dispute
        • Dispute
      • Notification
        • Dispute Notification
        • Alert Notification
  1. 接入指引

Dispute Service 服务使用指引

本章节为抗辩流程中不同业务场景API的使用说明。

Step1 退单通知#

EVO Payment收到卡组织差错后,对一次退单交易通过Dispute Service自动发送通知。
主要流程如下:
在Dispute Service收到新的一次退单时,会调用Notification接口,发送通知给到商户。
以下是一个收到的完整的Notification样例

Step2 抗辩#

抗辩类API由商户发送

Option1 不抗辩#

当商户接收到一次退单通知时,可以选择直接接受退单,不进行抗辩。
主要流程如下:
当商户收到通知时,可以根据通知中的disputeInfo.result、action.type、action.suggestion来判断是否接受该退单。
如接受,则需要调用Dispute接口,在调用接口时需要包含但不限于以下参数,字段详情参考 API 文档:
disputeMode:标识该API的目的,用于系统识别,此处需要商户赋值成"ACCEPT_DISPUTE_RESULT"
casoNo:标识该笔差错的案例编号
返回的信息中disputeInfo.status会变为"finished",代表该笔API处理成功,商户已经接受该退单。
以下是一个完整的接受退单的样例:
Request
Response

Option2 抗辩#

当商户接收到新增的一次退单通知时,可以选择抗辩,抗辩需要提交相关材料
主要流程如下:
商户可以根据通知中的disputeInfo.result、action.type、action.suggestion来判断是否接受该退单,如不接受,需要抗辩,则需要调用Dispute接口。在调用接口时需要包含但不限于以下参数,字段详情参考 API 文档:
disputeMode:标识该API的目的,用于系统识别,此处应该赋值为"DEFENSE_DOCUMENT"
casoNo:标识该笔差错的案例编号
fileMetaData:包含上传文件的信息
抗辩文件格式:支持PDF、Word、JPG、PNG
抗辩文件单一文件的大小不能超过5MB,最多支持五份文件同时上传
抗辩文件需要采用Base64编码格式上传。
返回的disputeInfo.status为"inDefense",代表上传文件成功,EVO Payment开始处理抗辩。
以下是一个完整的上传文件样例:
Request
Response

Option2.1 文件有误#

在抗辩流程开始时,商户需要通过API提交抗辩所需要的材料,提交完成后,如果材料格式错误或者需要补充其他材料,Dispute Service会发送API通知商户补充文件,商户通过API补充最新的文件后,如无需再次补充材料,则抗辩继续。
主要流程如下:
a):如文件不合规,Dispute Service会通过API通知商户抗辩文件有误,错误原因会在特定字段documentErrorRemarks中注明。
b):商户在收到通知后,调用Dispute接口上传最新的文件,此处操作和Step2.Option2 上传文件一致,仅需将disputeMode赋值为"DEFENSE_DOCUMENT_UPDATE"。返回的disputeInfo.status为"continueDefensing",代表更新文件成功,EVO Payment将在确认文件无误后开始处理抗辩。
以下是通知和上传文件的完整的API样例:
文件错误通知
上传文件:
Request
Response

Step3 抗辩结果通知#

在收到卡组织的抗辩结果后,Dispute Service会发送通知API通知用户结果
主要流程如下:
在收到卡组织的抗辩结果后,Dispute Service将发送通知API通知商户结果,此时商户可以在result字段中找到对应的结果,并决定是否继续抗辩
抗辩结果通知的API和退单通知的API结构相同,不同点在于,退单通知API的Result字段是固定值newChargeback,而抗辩结果通知的API为结果关键字+具体信息的组合

Step4结果处理#

Option1 接受结果#

在收到抗辩结果后,商户可以选择接受抗辩结果
主要流程同Step2.Option1

Option2 继续抗辩#

在收到抗辩结果后,商户可以选择继续抗辩
主要流程同Step2.Option2,后续的文件检查/更新、结果通知也与Option2.1和Step3相同

查询抗辩信息#

商户可以调用查询API来查询一笔差错交易的详细信息
基于使用的查询参数不同,得到的结果也不同
请注意:目前Dispute Service只支持查询一年以内的,差错类型为Chargeback的差错案例查询,如目标案例的创建日期至今超过了一年,则不会被查询到
查询方法:
1.使用caseNo查询
查询结果:指定caseNo的一次退单差错交易
2.使用时间范围查询
查询结果:指定时间范围内的指定门店下所有一次退单差错交易
在查询时,商户需要上送startDate和endDate字段,用于注明查询的时间范围,如只单独上传startDate或endDate,则系统将默认查询上传字段中对应日期的一次退单差错交易
例:商户只上送了startDate=20250301,则查询20250301当日对应门店下所有的一次退单差错交易
3.使用商户订单号查询
查询结果:指定订单号相关联的一次退单差错交易
请注意:在未注明日期时,默认查找最近一个月内相关联的一次退单差错交易
在查询之前,商户需要在路径中填写对应的域名和门店ID,并在body部分使用上述方法中的一种进行查询
以下是一个查询一条差错信息后,返回的完整样例:
下一页
安全要求及报文格式
Built with