查询退款结果
本章主要介绍查询退款结果接口,商户可以调用该接口主动查询退款状态。
应用场景
需要调用查询退款结果接口的场景如下:
- 商户后台、网络、服务器等出现异常,商户最终未接收到退款结果通知。
- 调用退款接口后,返回系统错误或未知交易状态。
- 调用退款接口未填写
notify_url
参数,需主动查询退款状态。
接口描述
- URL 地址:GET https://api.edgeros.com/pay/v1/transactions/refund。
- 传参方式:query(参数需在请求 URL 传参)。
- 是否需要签名:需要,详情请参见 生成数字签名。
请求参数
字段名 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
mch_refund_no | String(50) | 否 | mp202104021606341385640107521832 | 商户退单号,与翼辉支付退单号二选一,不能同时为空,同时存在时,以翼辉支付退单号优先 |
refund_no | String(50) | 否 | AR202112151405438637829842922855012187 | 翼辉支付退单号,与商户退单号二选一,不能同时为空,同时存在时,以翼辉支付退单号优先 |
aco_pay_sdk | String(12) | 否 | 2.0.0 | 翼辉支付 Java SDK 的版本号 |
version | String(3) | 否 | 1.0 | 调用接口版本,固定值 1.0 |
请求示例
https://api.edgeros.com/pay/v1/transactions/refund?mch_refund_no=mp202104021606341385640107521832&refund_no=AR202112151405438637829842922855012187&aco_pay_sdk=2.0.0&version=1.0
响应参数
字段名 | 类型 | 示例值 | 说明 |
---|---|---|---|
status | int | 200 | 返回状态码 |
message | String(100) | SUCCESS | 返回信息,取值为 SUCCESS 表示调用成功,其余均为调用失败,详情请参见 错误码 |
fieldErrors | String(50) | 此订单不存在 | 异常信息,当 message 不为 SUCCESS 时,返回具体错误原因 |
data | object | "data": {} | 具体业务返回信息 |
status
为 200
时,data
返回如下字段:
字段名 | 类型 | 示例值 | 说明 |
---|---|---|---|
mch_no | String(32) | MCH1000000 | 翼辉支付平台分配的商户号 |
nonce | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串,长度不大于 32 位 |
sign | String(344) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,商户需要验证签名,详情请参见 验证数字签名 |
sign_type | String(20) | SHA256withRSA | 签名类型,目前支持 SHA256withRSA |
mch_trade_no | String(32) | mp202104021606341385640107521832 | 商户订单号 |
mch_refund_no | String(32) | dx202104021606341385640107521832 | 商户退单号 |
transaction_no | String(20) | b2dec937881541afb127c0f4e2b12313 | 翼辉支付订单号 |
refund_no | String(50) | AR202112151405438637829842922855012187 | 翼辉支付退单号 |
refund_amount | String(9) | 0.01 | 退款金额,单位为元,保留小数点后两位 |
code | String(50) | SUCCESS | 业务状态代码,取值如下:
|
description | String(200) | 成功 | 业务状态代码描述 |
refund_reason | String(32) | 下单错误,申请退款 | 具体退款原因 |
success_time | String(32) | 2024-04-24T17:15:21+08:00 | 退款成功时间 |
refund_channel | String(10) | WECHAT_PAY | 订单的退款渠道,取值如下:
|
响应示例
正确响应示例
{
"status": 200,
"message": "SUCCESS",
"fieldErrors": null,
"data": {
"mch_no": "MCH1000000",
"nonce": "5K8264ILTKCH16CQ2502SI8ZNMTM67VS",
"sign": "C380BEC2BFD727A4B6845133519F3AD6",
"sign_type": "SHA256withRSA",
"mch_trade_no": "mp202104021606341385640107521832",
"mch_refund_no": "dx202104021606341385640107521832",
"transaction_no": "b2dec937881541afb127c0f4e2b12313",
"refund_no": "AR202112151405438637829842922855012187",
"refund_amount": "0.01",
"code": "SUCCESS",
"description": "成功",
"refund_reason": "下单错误,申请退款",
"success_time": "2024-04-24T17:15:21+08:00",
"refund_channel": "WECHAT_PAY"
}
}
错误响应示例
{
"status": 1007,
"message": "ORDER_NOT_EXIST",
"fieldErrors": "此订单不存在!",
"data": {
"mch_no": "MCH1000000",
"sign_type": "SHA256withRSA",
"sign": "BOMPq9ZN7GFeT5CXktP5JBx9qJnvzWpFqQS+QgTFDj59gCBF25pnA428VwdeloNkx2fo/z7lI0GINNNK8eybXlq2hWGEUO/ZT/cZXDAP+NkMq+T7MBXUsdQ606psV1uVYNLhFYaDYwDDRPwSO4gMcFmtpJti00kWFnQBIAsUmpbfOYB5piWcFd0pox8YML/5CDSaSTBjf8V3LHhOEz3bdg1M+LDLPWEc+SId3IWs1+rr4Rs9w+CAi8foV45M2BgoP/bvY01+72DCGQSZ4DCcvZtvXMR14iJWl1FG+UaEL6uWHKuvho9kr7exW9wCdZN0t2FmxU+OtdqK5tclfFnz3g==",
"nonce": "BhQKxrTTopAeUtaFPVDaiz8UMIxBtMTm"
}
}