跳到主要内容

取消退款

开放待确认。 查看适用范围。

对象与完整字段 · 认证、金额与错误 · 接入指南

POST /v1/refunds/{id}/cancel

申请取消一笔退款。仅 requires_action 状态可申请,是否允许取消以操作结果为准;processing、succeeded 状态拒绝取消。已取消的退款再次取消,返回当前对象。

Attributes​

属性位置类型必填说明
Idempotency-Keyheaderstring是本次操作的唯一键;重试沿用原值
idpathstring是退款的唯一标识

请求体为 {}。仅允许操作当前商户的退款,退款不存在或无权访问时统一返回 404。错误响应及幂等行为沿用商户 API 通用约定。

取消成功后释放占用额度,商户才可创建替代退款。请求超时或无法确定取消结果时,沿用原幂等键重试;有效幂等重试返回首次操作结果。

请求示例​

POST /v1/refunds/re_cancel_example/cancel
Authorization: Bearer inv_test_...
Content-Type: application/json
Idempotency-Key: ec3a7e90-673e-41a1-94d0-6724fba6a339
{}

返回示例​

200 OK,返回状态为 canceled 的完整 Refund 对象,next_action 为 null。取消保留最近执行错误,不产生新的执行错误。

{
"id": "re_cancel_example",
"attempt_id": "8b8fbb6b-4ec7-48d1-92a1-3b20c24b0c21",
"payment_intent": "pi_example",
"amount": "2.5",
"currency": "usdc",
"status": "canceled",
"payment_method": {
"type": "erc20_transfer",
"erc20_transfer": {
"chain": 56,
"recipient_address": "0x1234567890abcdef1234567890abcdef12345678"
}
},
"next_action": null,
"last_execution_error": null,
"description": "Price adjustment",
"metadata": {
"return_id": "RETURN_001"
},
"created_at": "2026-10-27T08:00:00Z",
"updated_at": "2026-10-27T08:01:00Z"
}

业务错误码