申请退款

更新时间:
2024-07-24
下载文档

申请退款

本章主要介绍申请退款接口,当交易成功后,在 180 天内,商户或消费者有退款需求时,商户可调用此接口把支付金额原路退还给消费者。

接口描述

  • URL 地址:POST https://api.edgeros.com/pay/v1/transactions/refund。
  • 传参方式:body(JSON 格式)。
  • 是否需要签名:需要,详情请参见 生成数字签名

请求参数

字段名类型是否必填示例值说明
transaction_noString(50)AP202112151150252267829842920145605378 翼辉支付订单号,与商户订单号二选一,不能同时为空,同时存在时,以翼辉支付订单号优先
mch_trade_noString(50)mp202104021606341385640107521832商户订单号,与翼辉支付订单号二选一,不能同时为空,同时存在时,以翼辉支付订单号优先
mch_refund_noString(50)mr202104071625921806284821327855商户系统的内部退款单号,每个商户唯一,由数字、字母、中划线、下划线构成,区分大小写,最小长度为 24,最大长度为 50
refund_amountString(9)12.50申请的退款金额,单位:元,保留小数点后两位,最大值不能超过原订单支付金额,最小值为 0.01
refund_reasonString(32)购买的虚拟商品未到账户申请的退款原因
notify_urlString(256)https://your.domain.com/path/to/refund/notify异步接收翼辉支付退款结果通知的回调地址,通知 URL 必须为外网可访问的 URL,请求方式为 POST,不允许 URL 传参,且必须是 HTTPS 地址
aco_pay_sdkString(12)2.0.0翼辉支付 Java SDK 的版本号
versionString(3)1.0调用接口版本,固定值 1.0

请求示例

{
  "transaction_no": "AP202112151150252267829842920145605378",
  "mch_trade_no": "mp202104021606341385640107521832",
  "mch_refund_no": "mr202104071625921806284821327855",
  "refund_amount": "12.50",
  "refund_reason": "购买的虚拟商品未到账户",
  "notify_url": "https://your.domain.com/path/to/refund/notify",
  "aco_pay_sdk": "2.0.0",
  "version": "1.0"
}

响应参数

字段名类型示例值说明
statusint200返回状态码
messageString(100)SUCCESS返回信息,取值为 SUCCESS 表示调用成功,其余均为调用失败,详情请参见 错误码
fieldErrorsString(50)订单不存在异常信息,当 message 不为 SUCCESS 时,返回具体错误原因
dataobject"data": {}具体业务返回信息

status200 时,data 返回如下字段:

字段名类型示例值说明
mch_noString(32)MCH1000000翼辉支付平台分配的商户号
nonceString(32)5K8264ILTKCH16CQ2502SI8ZNMTM67VS随机字符串,长度不大于 32 位
signString(344)C380BEC2BFD727A4B6845133519F3AD6签名值,商户需要验证签名,详情请参见 验证数字签名
sign_typeString(20)SHA256withRSA签名类型,目前支持 SHA256withRSA
app_noString(50)APP1000000支付应用号
mch_refund_noString(50)mr202104071629218062848213267855商户退款单号
refund_noString(50)AR202112151405438637829842922855012187翼辉支付退款单号
transaction_noString(50)4af336b1bd904c69ab2edb76af3a2a35翼辉支付订单号
mch_trade_noString(32)mp202104021606341385640107521832商户订单号
refund_amountString(9)0.01退款金额,单位为元,保留小数点后两位
codeString(20)SUCCESS业务状态代码,取值如下:
  • SUCCESS:申请成功
  • FAIL:申请失败
descriptionString(20)申请成功业务状态描述
refund_channelString(10)WECHAT_PAY订单的退款渠道,取值如下:
  • ALI_PAY:支付宝
  • WECHAT_PAY:微信

响应示例

正确响应示例

{
  "status": 200,
  "message": "SUCCESS",
  "fieldErrors": null,
  "data": {
    "mch_no": "MCH1000000",
    "nonce": "5K8264ILTKCH16CQ2502SI8ZNMTM67VS",
    "sign": "C380BEC2BFD727A4B6845133519F3AD6",
    "sign_type": "SHA256withRSA",
    "app_no": "APP1000000",
    "mch_refund_no": "mr202104071629218062848213267855",
    "refund_no": "AR202112151405438637829842922855012187",
    "transaction_no": "4af336b1bd904c69ab2edb76af3a2a35",
    "mch_trade_no": "mp202104021606341385640107521832",
    "refund_amount": 0.01,
    "code": "SUCCESS",
    "description": "申请成功",
    "refund_channel": "WECHAT_PAY"
  }
}

错误响应示例

{
  "status": 1001,
  "message": "INVALID_PARAMETER",
  "fieldErrors": "订单不存在!",
  "data": {
    "mch_no": "MCH1000000",
    "sign_type": "SHA256withRSA",
    "sign": "KTtHZcy5jAO0bALK2esUyafmZGT0BKf9B/MmM8mHPlH+epGLHKV2D2OEzMfFUY7RIxnNGA6qo51u/HjsdjDFS+e8FZkG+59VUzc9K19IgF/PjEY/ckUhfbxh+ZROKhuJq1NSfUSll5qXVc2M+EJcCAnkrvkA+dvCR1SSwBDcInyAsBW5ntYAeAC+1FpPfAE9TuVkiuJ+V0NSXBknV8f3LjYQgFaL/kc2W3tRLtfmAk1vv9mS7a7nmi8CECKPZkODzse8lj/jhuUAE6XssrT3AjBVlwA5/ceoFPZJwhVOeomPA4XkWfuSU1Mi0qq42v6ijR4ew5GegdfmZPHM0s0h3Q==",
    "nonce": "3eif5GQeZV6ekHgFekoGyjn2DvujOCIR"
  }
}
文档内容是否对您有所帮助?
有帮助
没帮助