import com.chinaums.open.api.OpenApiCache;
import com.chinaums.open.api.OpenApiContext;
import com.chinaums.open.api.constants.ConfigBean;
import com.chinaums.open.api.internal.util.http.HttpTransport;
import java.util.UUID;
public class OpenApiSdkTest {
public static void main(String[] args) throws Exception{
String url = "https://api-mop.chinaums.com/v1/netpay/refund";
//开发者ID
String appId = "平台分配";
//开发者秘钥
String appKey = "平台分配";
//实例化客户端
ConfigBean configBean = new ConfigBean();
OpenApiContext context = new OpenApiContext();
String request = "{\"requestTimestamp\":\"2022-04-15 10:42:59\",
\"merOrderId\":\"327M202204141724489725391331\",
\"instMid\":\"YUEDANDEFAULT\",
\"mid\":\"898340149000005\",
\"tid\":\"00000001\",
\"refundAmount\":\"1\",
\"msgId\":\"TDCDFD91420230700079549371\",
\"srcReserve\":\"保留字段\",
\"refundOrderId\":\"14HC202307191629589288166704\",
\"platformAmount\":\"680\",
\"subOrders\":\"[{\"mid\":\"898310148160568\",\"merOrderId\":\"14HC202307191435078140652400\",\"refundOrderId\":\"14HC202307191629589288166704\",\"totalAmount\":\"1\"}]\",
\"refundDesc\":\"退款\"}";
context.setStartTime(System.currentTimeMillis());
context.setRequestId(UUID.randomUUID().toString().replace("-", ""));
context.setOpenServUrl(url.split("/v")[0].concat("/"));
context.setApiServiceUrl(url);
context.setVersion(url.split("/")[3]);
context.setAppId(appId);
context.setAppKey(appKey);
context.setConfigBean(configBean);
context.setServiceCode(url.split("/v")[1].substring(1));
OpenApiCache.getCurrentToken(context);
System.out.println(HttpTransport.getInstance().doPost(context, request));
}
}
<?php
require_once "../utils/Log.php";
require_once "../utils/Tools.php";
require_once "../DefaultOpenApiClient.php";
class DataRequest
{
public $url = "";
public $serviceCode = "";
public $apiVersion ="";
public $needToken = true;
public $needDataTag = false;
public $data;
function __construct($data, $url)
{
$this->data = $data;
$apiVersion = preg_split("/[/]+/s",$url)[2];
$this->apiVersion = $apiVersion;
$serviceCode = strstr($url,$apiVersion);
$this->url = strstr($url,"/".$apiVersion,true);
$this->serviceCode = preg_replace("/^" . preg_quote($apiVersion, "/") . "/", "", $serviceCode);
}
}
class DataDemo{
public function main(){
$appid = "平台分配";
$appkey = "平台分配";
$url = "https://api-mop.chinaums.com/v1/netpay/refund";
$data = json_encode(array("requestTimestamp"=>"2022-04-15 10=>42=>59",
"merOrderId"=>"327M202204141724489725391331",
"instMid"=>"YUEDANDEFAULT",
"mid"=>"898340149000005",
"tid"=>"00000001",
"refundAmount"=>"1",
"msgId"=>"TDCDFD91420230700079549371",
"srcReserve"=>"保留字段",
"refundOrderId"=>"14HC202307191629589288166704",
"platformAmount"=>"680",
"subOrders"=>"json_encode(array([{"mid"=>"898310148160568","merOrderId"=>"14HC202307191435078140652400","refundOrderId"=>"14HC202307191629589288166704","totalAmount"=>"1"}]))",
"refundDesc"=>"退款"));
$reqiest = new DataRequest($data,$url);
$client = new DefaultOpenApiClient();
$content = $client->execute($reqiest,$appid,$appkey);
$obj = json_decode($content);
print_r($obj->errCode);
print_r($obj->errInfo);
}
}
$p = new DataDemo();
$p->main();
?>
# -*- coding: utf-8 -*-
from webapi.DefaultOpenApiClient import DefaultOpenApiClient
url = "https://api-mop.chinaums.com/v1/netpay/refund"
class DataRequest(object):
def __init__(self, data: dict) -> dict:
self.data = data
self.serviceCode = url[len(url.split("/v")[0])+len(url.split("/")[3])+1: len(url)]
self.apiVersion = url.split("/")[3]
self.needToken = True
self.needDataTag = True
appId="平台分配"
appKey="平台分配"
client = DefaultOpenApiClient(appId, appKey)
cls = DataRequest({\"requestTimestamp\":\"2022-04-15 10:42:59\",
\"merOrderId\":\"327M202204141724489725391331\",
\"instMid\":\"YUEDANDEFAULT\",
\"mid\":\"898340149000005\",
\"tid\":\"00000001\",
\"refundAmount\":\"1\",
\"msgId\":\"TDCDFD91420230700079549371\",
\"srcReserve\":\"保留字段\",
\"refundOrderId\":\"14HC202307191629589288166704\",
\"platformAmount\":\"680\",
\"subOrders\":\"[{\"mid\":\"898310148160568\",\"merOrderId\":\"14HC202307191435078140652400\",\"refundOrderId\":\"14HC202307191629589288166704\",\"totalAmount\":\"1\"}]\",
\"refundDesc\":\"退款\"})
response = client.execute(cls)
print(str(response.get("data")))
print(response.get("errCode"))
print(response.get("errInfo"))
print(response.get("resultCode"))
print(response.get("resultInfo"))
退款
URL
- 生产环境:
POST
https://api-mop.chinaums.com/v1/netpay/refund - 测试环境:
POST
https://test-api-open.chinaums.com/v1/netpay/refund
描述:当成功交易之后一段时间内,由于买家或商户的原因需要退款时,商户可以通过本接口将支付款退还给买家,退款请求验证成功之后,银商将通知支付渠道方按照退款规则把支付款按原路退回到买家帐号上。退款订单号refundOrderId也需遵循商户订单号生成规范,即以银商分配的4位来源编号作为账单号的前4位,且在商户系统中此账单号保证唯一。总长度需大于6位,小于28位。银商的推荐规则为(无特殊情况下,建议遵守此规则):{来源编号(4位)}{时间(yyyyMMddmmHHssSSS)(17位)}{7位随机数}
ContentType:HTTP(S) + JSON
请求头
名称 | 必填 | 描述 | 示例值 |
---|---|---|---|
Authorization | 是 | 认证内容(认证参考天满开发者中心->接入指引->平台认证方式:开发者中心 ) | OPEN-BODY-SIG AppId="****",Timestamp="20170606135700",Nonce="99930a147f5353dd8a8f29a5329f37e9",Signature="IPmdGHYCcfN+mto0/02zkwoUF1NT3YqPKaUykMaec1T=" |
请求参数
名称 | 类型 | 必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
requestTimestamp | string | 是 | 报文请求时间 格式yyyy-MM-dd HH:mm:ss | 2022-04-15 10:42:59 | |
merOrderId | string | 是 | 6..32 | 商户订单号 原交易订单号 | 327M202204141724489725391331 |
instMid | string | 是 | 8..32 | 业务类型 YUEDANDEFAULT | YUEDANDEFAULT |
mid | string | 是 | 15 | 商户号 | 898340149000005 |
tid | string | 是 | 8 | 终端号 | 00000001 |
refundAmount | number | 是 | 1..100000000 | 要退货的金额 若下单接口中上送了分账标记字段divisionFlag,则该字段refundAmount=subOrders中totalAmount之和+platformAmount | 1 |
msgId | string | 否 | <=64 | 消息ID 原样返回 | TDCDFD91420230700079549371 |
srcReserve | string | 否 | <=255 | 请求系统预留字段 | 保留字段 |
refundOrderId | string | 否 | 6..32 | 退款订单号 多次退款必传,每次退款上送的refundOrderId值需不同,若多次退货,且后续退货上送的merOrderId和refundOrderId字段与之前退货上送的值一致,将不会走退货逻辑,而是返回已有退货订单的退货信息,遵循商户订单号生成规范 | 14HC202307191629589288166704 |
platformAmount | number | 否 | 0..100000000 | 平台商户退款分账金额 若原交易是分账交易,则分账金额必传,且退款接口platformAmount小于下单接口中上送的platformAmount | 680 |
subOrders | array | 否 | 子订单信息 若原交易有分账,退款时必填。且退款接口totalAmount小于下单接口中上送的subOrders中对应mid下的totalAmount。(支持对多个子商户号同时发起退款 ) | ||
mid | string | 否 | 15 | 子商户号 | 898310148160568 |
merOrderId | string | 否 | 6..32 | 商户子订单号 | 14HC202307191435078140652400 |
refundOrderId | string | 否 | 6..32 | 商户退款子订单号 | 14HC202307191629589288166704 |
totalAmount | number | 否 | 0..100000000 | 子商户分账金额 | 1 |
refundDesc | string | 否 | <=255 | 退货说明 | 退款 |
响应示例
{
"errCode":"SUCCESS",
"errMsg":"现金退款成功",
"responseTimeStamp":"2022-04-15 10:42:59",
"mid":"898340149000005",
"tid":"00000001",
"refundMerchantContribute":"35",
"refundOtherContribute":"35",
"msgId":"0DUNOje1Bwtue6XinEs7DWhKS2NmUCVg",
"srcReserve":"保留字段",
"merOrderId":"14HC202307191435078140652400",
"merName":"测试商户",
"seqId":"35316083395N",
"status":"TRADE_SUCCESS",
"targetMid":"463293816",
"targetOrderId":"SUCCESS|SUCCESS",
"targetStatus":"",
"targetSys":"WXPay",
"totalAmount":"63",
"refundAmount":"63",
"refundFunds":"现金:63",
"refundFundsDesc":"现金退款0.63元",
"refundInvoiceAmount":"63",
"refundOrderId":"14HC202307191629589288166704",
"refundTargetOrderId":"50101606602023071990193380315",
"refundStatus":"",
"yxlmAmount":"35"
}
响应参数
名称 | 类型 | 必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
errCode | string | 是 | 错误代码 平台错误码 业务错误码 |
SUCCESS | |
errMsg | string | 否 | 错误说明 | 现金退款成功 | |
responseTimeStamp | string | 是 | 报文应答时间 格式yyyy-MM-dd HH:mm:ss | 2022-04-15 10:42:59 | |
mid | string | 是 | 15 | 商户号,原样返回 | 898340149000005 |
tid | string | 是 | 8 | 终端号,原样返回 | 00000001 |
refundMerchantContribute | number | 是 | - | 商户出资优惠金额 目前支持微信返回,其他渠道产品规划中 | 35 |
refundOtherContribute | number | 是 | - | 其他出资优惠金额 目前支持微信返回,其他渠道产品规划中 | 35 |
msgId | string | 否 | <=64 | 消息ID,原样返回 | 0DUNOje1Bwtue6XinEs7DWhKS2NmUCVg |
srcReserve | string | 否 | <=255 | 请求系统预留字段 | 保留字段 |
merOrderId | string | 否 | 商户订单号 | 14HC202307191435078140652400 | |
merName | string | 否 | 商户名称 | 测试商户 | |
seqId | string | 否 | 平台流水号 | 35316083395N | |
status | string | 否 | 交易状态 | TRADE_SUCCESS | |
targetMid | string | 否 | 支付渠道商户号 | 463293816 | |
targetOrderId | string | 否 | 目标平台单号 退货交易时不返回 | SUCCESS | |
targetStatus | string | 否 | 目标平台状态 | ||
targetSys | string | 否 | 目标平台代码 | WXPay | |
totalAmount | number | 否 | 支付总金额 | 63 | |
refundAmount | string | 否 | 总退款金额 | 63 | |
refundFunds | string | 否 | 退款渠道列表 | 现金:63 | |
refundFundsDesc | string | 否 | 退款渠道描述 | 现金退款0.63元 | |
refundInvoiceAmount | number | 否 | 实付部分退款金额 | 63 | |
refundOrderId | string | 否 | 退货订单号 | 14HC202307191629589288166704 | |
refundTargetOrderId | string | 否 | 目标系统退货订单号 | 50101606602023071990193380315 | |
refundStatus | string | 否 | 退款状态 | ||
yxlmAmount | number | 否 | 营销联盟优惠金额 仅享受联盟优惠的订单,查询返回 | 35 |