统一收单交易撤销接口

开发环境

http://dev-cn.your-api-server.com

POST

/v3/alipay/trade/cancel

alipay.trade

支付交易返回失败或支付系统超时，调用该接口撤销交易。如果此订单用户支付失败，支付宝系统会将此订单关闭；如果用户支付成功，支付宝系统会将此订单资金退还给用户。
注意：只有发生支付系统超时或者支付结果未知时可调用撤销，其他正常支付的单如需实现相同功能请调用申请退款API。提交支付交易后调用【查询订单API】，没有明确的支付结果再调用【撤销订单API】。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/trade/cancel' \
--header 'Content-Type: application/json' \
--data-raw '{
    "out_trade_no": "20150320010101001",
    "trade_no": "2014112611001004680073956707"
}'

响应示例

200 - 示例 1

{
    "action": "close",
    "out_trade_no": "6823789339978248",
    "refund_settlement_id": "2018101610032004620239146945",
    "retry_flag": "N",
    "trade_no": "2013112011001004330000121536",
    "gmt_refund_pay": {}
}

请求参数

Body 参数application/json

out_trade_no

string

可选

原支付请求的商户订单号,和支付宝交易号不能同时为空

示例值:

20150320010101001

trade_no

string

可选

支付宝交易号，和商户订单号不能同时为空

示例值:

2014112611001004680073956707

示例

返回响应

🟢200common response

application/json

Body

action

string

可选

本次撤销触发的交易动作,接口调用成功且交易存在时返回。可能的返回值： close：交易未支付，触发关闭交易动作，无退款； refund：交易已支付，触发交易退款动作；未返回：未查询到交易，或接口调用失败；

示例值:

out_trade_no

string

商户订单号

可选

示例值:

6823789339978248

refund_settlement_id

string

可选

当撤销产生了退款时，返回的退款清算编号，用于清算对账使用；只在银行间联交易场景下返回该信息；

示例值:

2018101610032004620239146945

retry_flag

string

是否需要重试

可选

示例值:

trade_no

string

可选

支付宝交易号; 当发生交易关闭或交易退款时返回；

示例值:

2013112011001004330000121536

gmt_refund_pay

string

可选

当撤销产生了退款时，返回退款时间；只在银行间联交易场景下返回该信息；

示例值:

{}

🔴500请求失败

修改于 2023-11-20 03:25:10

统一收单交易退款查询

统一收单交易关闭接口