CPAY接口文档


退款

接口说明 通用退款接口,可用于扫码支付(付款码支付、二维码支付),JSAPI支付,H5支付等退款

接口地址

http://xipay.xiangma365.com/api/openpay/v3/refundorder

请求方式

POST

请求头部

Content-Type:application/json

请求参数

参数 类型 必填 描述 示例
inst_no string Y 机构号 ,通道分配 60000001
mch_no string Y 商户号 Y52212200002
refund_trace_no string Y 请求流水号(系统方退款订单号) 31dafada31dskcada
refund_fee string Y 退款金额,单位:分 100
pay_time string Y 请求退款时间 2018116165053
trade_no string N 支付订单号 20000032114018111516011200013
pay_trace_no string N 支付请求流水号(与支付订单号二选其一) 201908050956210001
pay_trace_time string N 支付请求时间,格式yyyyMMddHHmmss 20190805095621
share_detail string N 涉及分账支付的退款时,需要添加相应的退款分账详情 “{\”share_count\”:\”2\”,\”share_fee_mch\”:\”通道商户号1\”,\”share_array\”:[{\”share_mch\”:\”通道商户号2\”,\”share_amount\”:\”122\”},{\”share_mch\”:\”通道商户号3\”,\”share_amount\”:\”322\”}]}”
notify_url string N 接收交易异步回调通知的接口地址 http://abc.com
sign string Y 签名字符串 51c7d68424e5492199cf7f4734a2b977

请求示例

通过支付订单号查询

{
   "inst_no": 60000001,
    "mch_no": "851808290003",
    "refund_trace_no": "11222323331323322",
    "refund_fee": "100",
    "trade_no": "20000002814118090716435200001",
    "pay_time": "20780907150901 ",
    "sign": "6e461f5c95c055b3aed017b8fcb8a1a9"
}

响应参数

参数 类型 必填 描述 示例
return_code string Y 响应码:SUCCESS成功,FAIL失败,响应码仅代表通信或参数 SUCCESS
return_msg string Y 返回信息提示,“支付成功”,“支付中”,“参数不合法” 等 支付成功

以下参数在return_code为SUCCESS时返回

参数 类型 必填 描述 示例
result_code string Y 业务结果:PAY_SUCCESS退款成功,PAY_FAIL退款失败,PAY_IN_PROCESS退款中,退款中需调用退款查询接口确认退款结果 PAY_SUCCESS
mch_no string Y 商户号 851811130002
shop_no string 门店号 86000033007
mch_name string Y 商户名称 小猫生活
shop_name string 门店名称 小猫生活
refund_trace_no string Y 退款请求流水号,系统原样返回 31dafada31dskcada
refund_fee string Y 退款金额,单位:分,有优惠时返回实退金额 100
pay_type string Y 支付类型:300支付宝,400微信,600云闪付,700.翼支付,800.数字人民币,900.龙支付 300
pay_time string Y 退款请求时间,yyyyMMddHHmmss 20181116155621
end_time string 支付完成时间,yyyyMMddHHmmss 20181116155621
qd_trade_no string 渠道订单号,可以用于扫码退款 null
refund_no string Y 平台退款单号 20000002824018090717585100001
sign string Y 签名 336437c53711dd466154c4162cbe1c52

返回示例 退款成功返回:

{
    "return_code":"SUCCESS",
    "return_msg":"退款成功",
    "result_code":"PAY_SUCCESS",
    "pay_type":"400",
    "mch_name":"小白盒周康宝岛牛肉饭",
    "shop_name":"",
    "mch_no":"851808290003",
    "shop_no":"",
    "refund_trace_no":"113332313422343003",
    "pay_time":"20480776150904",
    "refund_fee":"1",
    "end_time":"20180907175853",
    "refund_no":"20000002824018090717585100001",
    "qd_refund_no":null,
    "sign":"b4664a3e153e39e906663b04b462cda7"
}

页面列表

ITEM_HTML