在线 API争议

接受或争辩争议

当创建争议时，Afterpay 鼓励商户联系其客户。然后商户可以决定执行以下操作之一：

商户可以使用 Afterpay Business Hub 或以下 API 来接受或争辩争议。

目前，Afterpay 仅支持一轮证据提交，我们计划在未来支持多轮提交。

接受争议

商户可以调用以下端点来接受争议案例。此端点仅在争议处于非终态时有效，即争议状态不是 won 或 lost。

调用 API 会将争议状态转换为 lost。

接受争议 - 端点

POST https://{afterpay_global_url}/v2/disputes/{dispute_id}/accept

连接超时

超时类型时间（秒）
OPEN10
Read20

请求头

头部类型示例
User-AgentStringMyAfterpayModule/1.0.0 (E-Commerce Platform Name/1.0.0; PHP/7.0.0; Merchant/60032000) https://merchant.example.com
头部类型默认值
AcceptStringapplication/json

请求参数

字段名称数据类型描述
dispute_idString（必需）争议标识符。

响应

字段名称数据类型描述
disputeDisputeObject更新的争议对象。

争议对象示例

字段名称数据类型示例
idStringdp_ivpMnZkDhLykyXeoSr5WF4
orderString123456789
amountString48.46
currencyStringCAD
reasonStringpaid_by_other_means
statusStringlost
openBooleanfalse
responseDueByTimestamp1691884800
createdAtTimestamp1691884800
openingNoteStringCustomer has no knowledge of the Payment.
openingNoteAttachmentsFileId[“fi_48vmw3sXdVqvtJGXbgKbAZ”]
updatedAtTimestamp1691884800
closingReasonStringmerchant_accepted
closingNoteStringMerchant accepted the dispute
merchantOrderIdStringmerchantorderid12345
transactionDateTimestamp1691884800
settlementAmountString48.46
metaMetaObject"transactionAmount": "48.46",
"orderType": "ONLINE"

证据提交流程

如果商户不想接受争议，Afterpay 提供了通过 Afterpay Business Hub 或 API 提交证据来争辩争议的方式。

Afterpay 为商户提供文件上传 API，用于上传争辩争议所需的证据。文件上传 API 返回的令牌随后可以作为争议 API 端点请求/响应的一部分指定。有关文件上传 API 的详细信息，请参见上传文件。

回应争议

回应争议（例如，提交证据）端点使商户能够为争议提交证据。这仅在争议处于 needs_response 状态时允许。

这意味着，商户只有一次提交证据的机会。一旦收到 200 响应，此信息就无法更新或更改。

端点

POST https://{afterpay_global_url}/v2/disputes/{dispute_id}

连接超时

超时类型时间（秒）
OPEN10
Read20

请求头

头部类型示例
User-AgentStringMyAfterpayModule/1.0.0 (E-Commerce Platform Name/1.0.0; PHP/7.0.0; Merchant/60032000) https://merchant.example.com
头部类型默认值
AcceptStringapplication/json
Content-TypeStringapplication/json

请求参数

字段名称数据类型描述
idString给定争议的唯一 ID。
evidenceEvidence object请参见证据字段。注意至少应有一个有效字段。

响应

字段名称数据类型描述
disputeDisputeObject更新的争议对象。

证据字段

字段数据类型限制描述
productDescriptionString长度：1-5000 字符产品或服务的描述，以及在购买时向客户展示的任何相关详细信息。
refundPolicyString由上传文件端点生成的有效文件令牌文件上传的令牌。向客户展示或提供的商户退款政策。
refundPolicyDisclosureString长度：1-5000 字符解释在购买前如何以及何时向客户展示或提供商户的退款政策。
refundRefusalExplanationString长度：1-5000 字符商户解释为什么客户无权获得退款。
shippingDocumentationString由上传文件端点生成的有效文件令牌文件上传的令牌。争议支付的运输标签或收据。
shippingAddressString长度：1-5000 字符实物产品发货的地址。
shippingDateString长度：1-5000 字符对于实物产品，实物产品开始运往收货地址的日期，采用清晰的人类可读格式。此日期应早于争议日期。
shippingCarrierString长度：1-5000 字符对于实物产品，运送实物产品的快递服务，如 Fedex、UPS、USPS 等。如果此次购买使用了多个承运商，请用逗号分隔。
shippingTrackingNumberString长度：1-5000 字符从快递服务获得的实物产品的跟踪号。
uncategorizedFileString由上传文件端点生成的有效文件令牌文件上传的令牌。不属于上述任何类别的其他文件。
uncategorizedTextString长度：1-5000 字符商户认为相关的任何其他文本。