线上交易退款接口

本API为后台版接口,支持单笔且状态为成功的线上交易的全额或部分退款。

线上交易指:快捷支付页面版、网银支付页面版、手机网页支付接口。

请求参数

  • 请求地址

https://spin.cloudpnr.com/top-online-ser/refund

  • 公共请求参数

请求报文头HEADER - 「接口规则-参数规定-报文头」 ,请求报文体BODY - 「接口规则-参数规定-报文体」 ,响应报文体 - 「接口规则-参数规定-响应报文体」

  • 请求参数(data)
参数中文名称 参数名称 数据格式 是否必须 说明
请求流水号 req_seq_id 变长64位String 必须  
请求日期 req_date 定长8位String 必须 YYYYMMDD
商户号 huifu_id 变长32位String 必须  
订单金额 ord_amt 变长14位String 必须 订单金额,单位元,需保留小数点后两位,例如:1.00,最低传入0.01
原交易请求流水号 org_req_seq_id 变长64位String 可选 (org_req_seq_id、org_req_date),hf_seq_id必须传一组
原交易请求日期 org_req_date 固定8位String 可选  
汇付流水号 hf_seq_id 变128位String 可选  
设备信息 device_info String 必须 设备信息
异步通知地址 notify_url 变长512位String 必须 virgo://#{http_server_url} 例:virgo://http://www.xxx.com/getResp
原交易支付类型 pay_type 变长20位String 可选 快捷类交易必填:QUICK_PAY,其他不填
分账串 acct_split_bunch JSON 可选 请求分账串
风控信息 risk_check_info 变长4000位String 必须 jsonstring,风控信息
商户私有域 mer_priv 变长1024位String 可选  
备注 mark 变长45位String 可选 UrlEncode进行编码

设备信息

参数 中文名 类型 必填 最大长度 说明
trx_device_type 设备类型 String Y 2 01:手机,02:平板,03:手表,04:PC
trx_device_ip 交易设备IP String Y 45 用于标识交易设备IP地址,目前暂传IPv4格式
trx_device_mac 交易设备MAC String N 12 去掉特殊的连接符号,如冒号、连接符
trx_device_imei 交易设备IMEI String N 15  
trx_device_imsi 交易设备IMSI String N 15  
trx_device_icc_id 交易设备ICCID String N 20  
trx_device_wifi_mac 交易设备WIFIMAC String N 12  
trx_device_gps 交易设备GPS String N 23  

响应参数

  • 同步/异步响应参数(data/resp_data)
参数 中文名 类型 必填 最大长度 说明
sub_resp_code 返回码 String Y 8 业务返回码
sub_resp_desc 返回描述 String Y 512 业务返回描述
req_seq_id 请求流水号 String Y 64  
req_date 请求日期 String Y 8  
hf_seq_id 汇付流水号 String N 128  
product_id 产品号 String Y 32  
pay_type 原交易支付类型 String N 32 原交易支付类型
org_req_seq_id 原交易请求流水号 String N 64  
org_req_date 原交易请求日期 String N 8  
ord_amt 订单金额 String N 14 单位元,需保留小数点后两位,例如: 1.00
trans_time 交易时间 String N 6 交易发生时间,HHMMSS
huifu_id 商户号 String Y 32  
bank_code 通道返回码 String N 8  
bank_message 通道返回描述 String N 128  
trans_stat 交易状态 String N 1 P:处理中,S:成功,F:失败
actual_ref_amt 实际退款金额 String N 14 单位元,需保留小数点后两位,例如: 1.00
mer_priv 商户私有域 String N 1024  
trade_type 交易类型 String N   TRANS_REFUND
org_ord_amt 原交易订单金额 String N 14  
org_fee_amt 原交易手续费 String N 14  
total_ref_amt 原交易累计退款金额 String N 14  
acct_split_bunch 分账串 JSON N   返回分账串
total_ref_fee_amt 原交易累计退款手续费金额 String N 14  
ref_cut 累计退款次数 String N    

原交易支付类型

payType 备注
ONLINE_PAY_B2B B2B网银支付
ONLINE_PAY_B2C B2C网银支付
ONLINE_RECHARGE_B2B B2B网银充值
ONLINE_RECHARGE_B2C B2C网银充值
QUICK_PAY 快捷支付
QUICK_RECHARGE 快捷充值
WAP_PAY 手机网页支付
WAP_PAY_INSTALLMENT 手机网页支付(分期)

请求示例

{
    "sign": "lT5V6xBdJjJoUphJ0JRRKNrYkNyszk/pKuEdBq3g6pS6SuzooEuGF1PGOHuftgJVJAgMWnMEj5o03a0a33clT5A65dWclXMKfk4dPbC/YsGRKRgy4wMiy51E9X/xRncJle++b+TzFkYIA0rjtAtBlt1rFdSet7IUhzt9711fYQ5JZ1lq5fQVqYMUE3DMQgGI2EMPW0GVKXmCg9s+Pq10Rp4iiT5NFpUarcSUc7mSl1AJuIlWU6qJ2wDI8a7TNB0Epl4uQg8QJDXL8w/C3NN9U9zp8hd6PBN7P2kWMF1yQokjCo/K1dnm7+i4+7I4argtDkncRiKgq2nv5PWBcMHEKg==",
    "sign_type": "RSA2",
    "sys_id": "TEST",
    "data": "{\"req_seq_id\":\"refund20210127withold012\",\"req_date\":\"20210201\",\"huifu_id\":\"6666000003100615\",\"ord_amt\":\"0.01\",\"hf_seq_id\":\"\",\"org_req_seq_id\":\"2584124551922803\",\"org_req_date\":\"20210126\",\"notify_url\":\"virgo://aaa\",\"mer_priv\":\"virgo://aaa\"}"
}

响应示例

{
    "data": "{\"acct_split_bunch\":{\"acct_infos\":[{\"acct_date\":\"20210201\",\"div_amt\":\"0.01\",\"huifu_id\":\"6666000003100615\"}],\"fee_huifu_id\":\"6666000103409679\"},\"actual_ref_amt\":\"\",\"bagent_id\":\"6666000003099901\",\"bagent_name\":\"交易端使用\",\"bank_code\":\"\",\"bank_message\":\"\",\"hf_seq_id\":\"0047default210201154732P738c0a855d100000\",\"huifu_id\":\"6666000003100615\",\"mer_name\":\"盈盈超市\",\"mer_priv\":\"virgo://aaa\",\"ord_amt\":\"0.01\",\"org_fee_amt\":\"2.01\",\"org_ord_amt\":\"10.00\",\"org_req_date\":\"20210126\",\"org_req_seq_id\":\"2584124551922803\",\"pay_type\":\"\",\"product_id\":\"MYPAY\",\"req_date\":\"20210201\",\"req_seq_id\":\"refund20210127withold012\",\"sub_resp_code\":\"00000000\",\"sub_resp_desc\":\"成功\",\"total_ref_amt\":\"0.00\",\"total_ref_fee_amt\":\"0.00\",\"trans_date\":\"20210201\",\"trans_stat\":\"S\",\"trans_time\":\"\",\"trans_type\":\"TRANS_REFUND\"}",
    "resp_code": "10000",
    "resp_desc": "成功调用",
    "sign": "cr2Pz8NqaL995kJc/Mwfa8KnXjuW1P4Dk0wqlHWDZxQAqTGis3Jo9sOC7is6T3pljMMq5XtV7r2YphktAWnTdiDuhrIKCP89rRSOZkZXyt+gSi1h1QjNaBPh2CW/YAphDK6+k4Py4bymjLy5v/JPvU/Y7zCyDMJx7MaktyrnVXkm2vuCVtGU+QhCiltMpdjjprb0XOErctMfJozrbX4tEnKD0+hdnbaQqltqKfG8Bp7n1TVZQAj94ptQG+/FwFQg51QNgrxseQDXwGmgg1dW30R+EBn3DvzWaArqGBwpUsBuK3azPnb4Ti8mEpCnHUxDi42F0z/9lLq9uLCfu+OGyg=="
}

接口调用示例

Demo参考