申请退款
当交易发生之后一段时间内,由于买家或者商户的原因需要退款时,商户可以通过退款接口将支付款退还给买家,三方渠道平台将在收到退款请求并且验证成功之后,按照退款规则将支付款按原路退到买家账号上。
注意:
申请退款接口具体退款是否成功,需要通过退款查询接口获取结果。
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 应用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"
}
}
# 申请退款
curl -X POST "{BASE_URL}/v1/transactions/refund.html" \
-d "app_id={YOUR_APP_ID}" \
-d "out_trade_no=20240101123456" \
-d "out_refund_no=REF20240101001" \
-d "refund_amount=100" \
-d "refund_reason=%E9%80%80%E6%AC%BE" \
-d "sign=E10ADC3949BA59ABBE56E057F20F883E"
<?php
$appId = '{YOUR_APP_ID}';
$apiKey = '{YOUR_API_KEY}';
$params = [
'app_id' => $appId,
'out_trade_no' => '20240101123456',
'out_refund_no' => 'REF20240101001',
'refund_amount' => '100',
'refund_reason' => urlencode('退款'),
];
ksort($params);
$signStr = urldecode(http_build_query($params)) . '&key=' . $apiKey;
$params['sign'] = strtoupper(md5($signStr));
$ch = curl_init('{BASE_URL}/v1/transactions/refund.html');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
$response = json_decode($result, true);
print_r($response);
import hashlib
import requests
from urllib.parse import quote
app_id = '{YOUR_APP_ID}'
api_key = '{YOUR_API_KEY}'
params = {
'app_id': app_id,
'out_trade_no': '20240101123456',
'out_refund_no': 'REF20240101001',
'refund_amount': '100',
'refund_reason': quote('退款'),
}
sorted_keys = sorted(params.keys())
sign_str = '&'.join(f'{k}={params[k]}' for k in sorted_keys) + '&key=' + api_key
params['sign'] = hashlib.md5(sign_str.encode()).hexdigest().upper()
resp = requests.post('{BASE_URL}/v1/transactions/refund.html', data=params)
print(resp.json())
import java.io.*;
import java.net.*;
import java.security.MessageDigest;
import java.util.*;
public class Refund {
public static void main(String[] args) throws Exception {
String appId = "{YOUR_APP_ID}";
String apiKey = "{YOUR_API_KEY}";
Map<String, String> params = new TreeMap<>();
params.put("app_id", appId);
params.put("out_trade_no", "20240101123456");
params.put("out_refund_no", "REF20240101001");
params.put("refund_amount", "100");
params.put("refund_reason", URLEncoder.encode("退款", "UTF-8"));
StringBuilder sb = new StringBuilder();
for (Map.Entry<String, String> e : params.entrySet())
sb.append(e.getKey()).append("=").append(e.getValue()).append("&");
sb.append("key=").append(apiKey);
String sign = md5(sb.toString()).toUpperCase();
params.put("sign", sign);
String result = doPost("{BASE_URL}/v1/transactions/refund.html", params);
System.out.println(result);
}
static String md5(String s) throws Exception {
MessageDigest md = MessageDigest.getInstance("MD5");
byte[] digest = md.digest(s.getBytes("UTF-8"));
StringBuilder sb = new StringBuilder();
for (byte b : digest) sb.append(String.format("%02x", b));
return sb.toString();
}
static String doPost(String url, Map<String, String> params) throws Exception {
StringBuilder body = new StringBuilder();
for (Map.Entry<String, String> e : params.entrySet())
body.append(URLEncoder.encode(e.getKey(), "UTF-8"))
.append("=").append(URLEncoder.encode(e.getValue(), "UTF-8")).append("&");
HttpURLConnection conn = (HttpURLConnection) new URL(url).openConnection();
conn.setRequestMethod("POST");
conn.setDoOutput(true);
conn.getOutputStream().write(body.toString().getBytes("UTF-8"));
BufferedReader br = new BufferedReader(new InputStreamReader(conn.getInputStream(), "UTF-8"));
StringBuilder resp = new StringBuilder();
String line; while ((line = br.readLine()) != null) resp.append(line);
return resp.toString();
}
}
const crypto = require('crypto');
const axios = require('axios');
const querystring = require('querystring');
const appId = '{YOUR_APP_ID}';
const apiKey = '{YOUR_API_KEY}';
const params = {
app_id: appId,
out_trade_no: '20240101123456',
out_refund_no: 'REF20240101001',
refund_amount: '100',
refund_reason: encodeURIComponent('退款'),
};
const sortedKeys = Object.keys(params).sort();
const signStr = sortedKeys.map(k => `=`).join('&') + '&key=' + apiKey;
params.sign = crypto.createHash('md5').update(signStr).digest('hex').toUpperCase();
axios.post('{BASE_URL}/v1/transactions/refund.html', querystring.stringify(params))
.then(res => console.log(res.data));
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Security.Cryptography;
using System.Text;
var appId = "{YOUR_APP_ID}";
var apiKey = "{YOUR_API_KEY}";
var paramList = new List<KeyValuePair<string, string>> {
new("app_id", appId),
new("out_trade_no", "20240101123456"),
new("out_refund_no", "REF20240101001"),
new("refund_amount", "100"),
new("refund_reason", Uri.EscapeDataString("退款")),
};
paramList.Sort((a, b) => string.Compare(a.Key, b.Key, StringComparison.Ordinal));
var signStr = string.Join("&", paramList.Select(p => $"{p.Key}={p.Value}")) + "&key=" + apiKey;
using var md5 = MD5.Create();
var sign = BitConverter.ToString(md5.ComputeHash(Encoding.UTF8.GetBytes(signStr))).Replace("-","").ToUpper();
paramList.Add(new("sign", sign));
using var client = new HttpClient();
var resp = await client.PostAsync("{BASE_URL}/v1/transactions/refund.html", new FormUrlEncodedContent(paramList));
Console.WriteLine(await resp.Content.ReadAsStringAsync());
package main
import (
"crypto/md5"
"fmt"
"io"
"net/http"
"net/url"
"sort"
"strings"
)
func main() {
appId := "{YOUR_APP_ID}"
apiKey := "{YOUR_API_KEY}"
params := url.Values{}
params.Set("app_id", appId)
params.Set("out_trade_no", "20240101123456")
params.Set("out_refund_no", "REF20240101001")
params.Set("refund_amount", "100")
params.Set("refund_reason", url.QueryEscape("退款"))
keys := make([]string, 0)
for k := range params { keys = append(keys, k) }
sort.Strings(keys)
var parts []string
for _, k := range keys { parts = append(parts, k+"="+params.Get(k)) }
signStr := strings.Join(parts, "&") + "&key=" + apiKey
sign := fmt.Sprintf("%X", md5.Sum([]byte(signStr)))
params.Set("sign", sign)
resp, _ := http.PostForm("{BASE_URL}/v1/transactions/refund.html", params)
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}