申请退款

最近更新时间:2019-11-12 20:17:29

接口描述

url https://pay.qcloud.com/cpay/refund

输入参数

参数名 必填 类型 说明
request_content String 请求内容,该 string 可以转为 json 结构,json 格式见本节 RequestContent。
authen_info AuthenInfo 认证信息,详见接口调用说明。

RequestContent 结构

     
一级参数名 二级参数名 三级参数名 必填 类型 说明
refund_content out_trade_no - String(32) 订单号。
out_refund_no   - String(32) 退款单号。
total_fee - Number(32) 订单总金额,金额分。
refund_fee   - Number(32) 本次退款金额,金额分。
refund_fee_type - String(3) 本次退款货币类型。
refund_reason   - String(64) 退款原因备注。
client_refund_flow_id - Number(64) 客户端流水号。
out_freeze_no - String(32) 押金冻结单号(押金模式退款单必填)。
wx_pay_refund_content_ext* refund_account String(30) 退款资金来源,仅针对老资金流子商户使用。默认使用未结算资金退款。
pay_mch_key pay_platform - Number(32) 第三方支付类型。
out_mch_id - String(32) 服务商对外帐号。
out_sub_mch_id - String(32) 子商户对外帐号。
out_shop_id - String(32) 门店对外帐号。
is_sub_mch_admin - Bool 操作者是否为商户管理员(此参数是为了校验退款人身份,操作退款人必须拥有退款权限。true 代表操作者是商户管理员,该角色默认拥有退款权限。当为 false 时与 authorization_staff_id 配合使用校验退款权限)。
authorization_staff_id - String(64) 如果 is_sub_mch_admin 为 false,则此项为必填,如果为 true,则此项不填。
1. 如果当前 staff_id 有退款权限则传自身的 staff_id。
2. 如果是其他人授权则填授权者的 staff_id。
3. 机具调用传机具内配置的 staff_id。
authorization_name - String(32) 如果当前操作者有退款权限则传自身的 name,如果是其他人授权则填授权者的 name。此字段最终会补充在返回结构的退款原因(refund_reason)字段中。
order_client device_id - String(64) 子商户自定义,终端设备号。
terminal_type - Number(32) 终端类型,1:windows,2:andriod,3:iso,4:linux,100:其他。
sdk_version - String(10) 云支付 SDK 版本号。
spbill_create_ip - String(16) 调用云支付 API 的机器 IP。
sn_code - String(127) 设备 sn 号。
api_version - - Number(32) 默认为1。如果填1,则不认证操作者退款权限;如果填2,则需要结合 pay_mch_key 中的 is_sub_admin,authorization_staff_id 字段验证退款权限。
nonce_str - - String(32) 随机字符串。

*只有微信支付时才使用。

输出参数

参数名 必填 类型 说明
response_content ResponseContent 请求内容,详见本节 ResponseContent。
authen_info AuthenInfo 认证信息,详见接口调用说明。

ResponseContent 结构

参数名 必填 类型 说明
status Status 错误码,详见 Status。0:成功;非0:失败。
description String(255) 错误描述。
log_id Number(32) 消息 ID。
internal_status Number(32) 调试使用,调用者可以不予理会。
refund RefundResponse authen_info 存在时必填。详见 RefundResponse。

RefundResponse 结构

参数名 必填 类型 说明
pay_mch_key PayMchkey 支付商户信息,status 为0时必填。详见公共数据结构 PayMchKey。
refund_order_content RefundOrderContent 退款单信息,详见公共数据结构 RefundOrderContent。
nonce_str String(32) 随机字符串。

示例

输入参数示例:

{  
    "authen_info": {  
        "a": {  
            "authen_type": 1,  
            "authen_code": "0AFAFB3BF238BCD1BD2617C9AE720FA83D600911BA3E6FD95D62A5EED90569D6"  
        }  
    },  
    "request_content": "{  
            "refund_content": {  
                "out_refund_no": "sz010002cz11571214438",  
                "out_trade_no": "sz010002cz11571214366",  
                "refund_fee_type": "CNY",  
                "total_fee": 1,  
                "refund_reason": "returns",  
                "refund_fee": 1  
            },  
            "pay_mch_key": {  
                "pay_platform": 1,  
                "out_mch_id": "sz01lXKA6DKGjNzr2l4B""out_sub_mch_id": "sz01KzuCUOmw8yjtPite",  
                "out_shop_id": "sz011biKxOguirmBqiFR",  
                "is_sub_mch_admin": false,  
                "authorization_staff_id": "123123",  
                "authorization_name": "dianyuan"  
            },  
            "order_client": {  
                "terminal_type": 1,  
                "sdk_version": "1.0",  
                "spbill_create_ip": "90.0.00.0"  
            },  
            "api_version": 2,  
            "nonce_str": "E94C00688C3F429CA2B0B396BF823548"  
        }"  
}  

输出参数示例:

{  
    "response_content": "{  
            "status": 0,  
            "description": "\u64CD\u4F5C\u6210\u529F\u3002",  
            "log_id": 4237349548,  
            "internal_status": 0,  
            "refund": {  
                "pay_mch_key": {  
                    "pay_platform": 1,  
                    "out_mch_id": "sz01lXKA6DKGjNzr2l4B",  
                    "out_sub_mch_id": "sz01KzuCUOmw8yjtPite",  
                    "out_shop_id": "sz011biKxOguirmBqiFR",  
                    "sub_pay_platform": 100,  
                    "wxpay_pay_mch_key_ext": {  
                        "app_id": "wx998fa95558590s21",  
                    }  
                },  
                "refund_order_content": {  
                    "out_refund_no": "sz010002cz11571214438",  
                    "refund_id": "50000702232019101612463710837",  
                    "trade_type": 1,  
                    "out_trade_no": "sz010002cz11571214366",  
                    "nonce_str": "E94C00688C3F429CA2B0B396BF823548",  
                    "create_time": 1571214438,  
                    "last_update_time": 1571214440,  
                    "refund_reason": "returns\n\u64CD\u4F5C\u8005\uFF1A1206\n\u6388\u6743\u8005\uFF1Adianyuan",  
                    "total_fee": 1,  
                    "refund_fee": 1,  
                    "refund_fee_type": "CNY",  
                    "wxpay_refund_order_content_ext": {  
                        "state": 4,  
                        "cash_refund_fee": 1,  
                        "coupon_refund_fee": 0,  
                        "coupon_refund_count": 0  
                    },  
                    "is_deposit_mode": false,  
                },  
                "nonce_str": "ymT9uMh4CV7ZrgESjG2brAlb8a1I1knu"  
            }  
        }",  
    "authen_info": {  
        "a": {  
            "authen_type": 1,  
            "authen_code": "C4C73130FE6CBF1CF185909057067B622EBBF55E95339886A18024D2568CC699"  
        }  
    }  
}