易码付-申请退款

应用场景

当交易发生之后一段时间内，由于买家或者商户的原因需要退款时，商户可以通过退款接口将支付款退还给买家，三方渠道平台将在收到退款请求并且验证成功之后，按照退款规则将支付款按原路退到买家账号上。

注意：

申请退款接口具体退款是否成功，需要通过退款查询接口获取结果。

接口链接

请求方式：POST

URL地址：{BASE_URL}/v1/transactions/refund.html

请求参数

字段名	变量名	必填	类型	示例值	描述
应用ID	app_id	是	String	app_9ba59abbe56e057f20f	由易码付平台生成的应用ID，全局唯一。
商户订单号	out_trade_no	是	String	1217752501201407	需要退款的商户端交易订单号
退款单号	out_refund_no	是	String	1217752501035987	退款单号，由商户自行生成，保持商户端唯一
退款金额	refund_amount	是	Int	100	退款金额，单位为分。1元等于100分
退款原因	refund_reason	是	String	商品缺货	退款原因签名时无需转码，为避免中文乱码，传递时使用UrlEncode(UTF-8)编码，可参考编码/解码工具
签名串	sign	是	String	e10adc3949ba59abbe56e057f20f883e	待签名字符串进行MD5加密得出的32位签名值，参考签名规则

举例如下：

{BASE_URL}/v1/transactions/refund.html?app_id=app_159f7a1756bf8b08&out_trade_no=190009507085358&out_refund_no=15698523654125&refund_amount=100&refund_reason=%E7%BC%BA%E8%B4%A7&sign=f74e3b4a9e2bcb971c3a68c80286bc8e

返回结果

字段名	变量名	必填	类型	示例值	描述
业务状态码	resultCode	是	Int	200	200/201/500 此字段是业务标识状态码，200代表业务处理成功，并成功返回
业务状态描述	message	是	String	成功	当resultCode非200时返回信息为错误原因，例如 app_id错误或不存在
数据集	Data	否	String	-	当resultCode为200时，数据会装入该字段一并返回
	out_refund_no	是	String	1217752501035987	商户端退款单号
	refund_no	是	String	TK2108142002121923822	平台退款单号
	out_trade_no	是	String	1217752501201407	商户端交易单号
	trade_no	是	String	YH2307190011178361713	平台交易单号
	amount	是	Int	100	原交易订单的付款金额，单位为分。1元等于100分
	refund_amount	是	Int	100	退款金额，单位为分。1元等于100分
	refund_state	是	String	success	退款状态 success：退款成功 failed：退款失败 wait：退款中 close：订单关闭

举例如下：

{
    "resultCode":200,
    "message":"成功",
    "Data":{
        "out_refund_no":"15698523654125",
        "refund_no":"TK20220503123256123658",
        "out_trade_no":"190009507085358",
        "trade_no":"YH20220503123256123658",
        "amount":100,
        "refund_amount":100,
        "refund_state":"success"
    }
}

状态码

状态码	描述
200	成功
201	业务错误，具体错误信息请参照message字段
500	系统错误

API接口文档

申请退款

应用场景

接口链接

请求参数

返回结果

状态码