开发指南
API
官网
API 2.0
API 2.0 > 4.3 全渠道订单 > 4.3.3 退款单上送

4.3.3 退款单上送

开启令牌和权限后可调用。签名方式请查看开发指南
场景描述：针对退款完成订单进行上传
零售 餐饮

请求地址

请求方式 版本信息 请求地址
POST V2 http://openapi.zvcms.com/api/v2

公共参数

参数 参数类型 是否必填 默认值 描述
OpenId string 是 密钥Id
GrantCode string 是 授权code
Token string 是 签名，参考《数字签名sign》
Timestamp string 是 当前时间戳
Nonce string 是 随机正整数
Action string 是 communal.order.refund-order-upload 接口方法
Params array 是 业务参数

请求参数

参数 参数类型 是否必填 默认值 描述
order_no string 是 第三方的订单号（在“全渠道订单——订单上送”接口中上传的订单号）
order_refund_no string 是 退款单号（最大长度20位）
amount float 是 微信或者支付宝的退款金额 退款金额（单位是元，保留2位小数）
wallet_amount float 是 余额退款金额（单位是元，保留2位小数）
industry_type int 是 行业类型。餐饮-1，零售-2
refund_type int 是 退款类型（1——部分退款，2——全部退款）
reason string 否 退款原因
note string 否 退款备注（说明）
apply_at string 是 申请时间（格式：2019-8-22 17:18:05）
refund_at string 是 商家同意，退款成功时间（格式：2019-8-22 17:18:05）
goods array 否
 ├0 array 否
  ├name string 是 退款商品名称
  ├trade_mark string 是 退款商品标识
  ├num int 是 退款的数量
  ├price float 是 商品价格
operate_name string 否 操作退款人员姓名
operate_code string 否 操作退款人员手机号码
other_amount sting 否 此字段针对订单上送接口中other_amount有值时的订单退款使用, 在退款时此值和订单中other_amount值一样, amount值为不包含other_amount金额的退款金额, 例如: 该笔订单总金额为20元(其他优惠不考虑), 在订单上送接口中amount为15元, other_amount为5元, 此订单退款时, 退款接口中amount参数为15元, other_amount参数为5元

响应参数

参数 参数类型 描述

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "communal.order.refund-order-upload",
    "Params": {
        "order_no": "",
        "order_refund_no": "",
        "amount": "",
        "wallet_amount": "",
        "industry_type": "",
        "refund_type": "",
        "reason": "",
        "note": "",
        "apply_at": "",
        "refund_at": "",
        "goods": [
            {
                "name": "",
                "trade_mark": "",
                "num": "",
                "price": ""
            }
        ],
        "operate_name": "",
        "operate_code": "",
        "other_amount": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": []
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}

请求地址

请求方式 版本信息 请求地址
POST V2 http://openapi.zvcms.com/api/v2

公共参数

参数 参数类型 是否必填 默认值 描述
OpenId string 是 密钥Id
GrantCode string 是 授权code
Token string 是 签名，参考《数字签名sign》
Timestamp string 是 当前时间戳
Nonce string 是 随机正整数
Action string 是 communal.order.refund-order-upload 接口方法
Params array 是 业务参数

请求参数

参数 参数类型 是否必填 默认值 描述
order_no string 是 第三方的订单号（在“全渠道订单——订单上送”接口中上传的订单号）
order_refund_no string 是 退款单号（最大长度20位）
amount float 是 微信或者支付宝的退款金额 退款金额（单位是元，保留2位小数）
wallet_amount float 是 余额退款金额（单位是元，保留2位小数）
industry_type int 是 行业类型。餐饮-1，零售-2
refund_type int 是 退款类型（1——部分退款，2——全部退款）
reason string 否 退款原因
note string 否 退款备注（说明）
apply_at string 是 申请时间（格式：2019-8-22 17:18:05）
refund_at string 是 商家同意，退款成功时间（格式：2019-8-22 17:18:05）
goods array 否
 ├0 array 否
  ├name string 是 退款商品名称
  ├trade_mark string 是 退款商品标识
  ├num int 是 退款的数量
  ├price float 是 商品价格
operate_name string 否 操作退款人员姓名
operate_code string 否 操作退款人员手机号码
other_amount sting 否 此字段针对订单上送接口中other_amount有值时的订单退款使用, 在退款时此值和订单中other_amount值一样, amount值为不包含other_amount金额的退款金额, 例如: 该笔订单总金额为20元(其他优惠不考虑), 在订单上送接口中amount为15元, other_amount为5元, 此订单退款时, 退款接口中amount参数为15元, other_amount参数为5元

响应参数

参数 参数类型 描述

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "communal.order.refund-order-upload",
    "Params": {
        "order_no": "",
        "order_refund_no": "",
        "amount": "",
        "wallet_amount": "",
        "industry_type": "",
        "refund_type": "",
        "reason": "",
        "note": "",
        "apply_at": "",
        "refund_at": "",
        "goods": [
            {
                "name": "",
                "trade_mark": "",
                "num": "",
                "price": ""
            }
        ],
        "operate_name": "",
        "operate_code": "",
        "other_amount": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": []
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}

免费升级

营销功能、插件持续每月更新开发升级

免费专业培训

每月建站、微信营销、电商等互联网增值培训

7×24小时服务支持

400电话、QQ、微信、在线等多渠道售后支持

 

安徽智迈科技股份有限公司 版权所有 Copyright 2009-2018 皖公网安备 34019202000074号 增值电信业务经营许可证：皖B2-20170075