## 创建退款申请(refundCreate) >[info] 场景说明:买家提交订单并付款后,未确认收货前,可以发起退款申请 ### 是否需要获取用户TOKEN `是` ***** ### 请求地址 ``` POST http://api.xxx.com/refund/create ``` ### 公共请求参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | appid | string | 必须 | 平台提供的唯一APPID | | version | string | 必须 | 接口版本号,固定填:v3 | | sign\_type | string | 必须 | 签名类型,目前只支持md5 | | timestamp | string | 必须 | 发起时间戳,格式为:yyyy-mm-dd hh::ii::ss | | format | string | 必须 | 返回的数据格式,只支持json | | sign | string | 必须 | 请求参数的签名,请参考:[签名规则](signature.md) | | token | string | 必须 | 用户TOKEN | | params | string | 必须 | 请求参数的集合,除公共参数外,所有请求参数都必须放在这个参数中传递,json\_encode后送入 | 应用请求参数`params`格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | order\_id | integer | 必须 | 要退款的订单ID | | refund\_total\_fee | decimal | 必须 | 退款金额 | | shipped | integer | 必须 | 收货情况, 0=未收到货,需要退款; 1=已收到货,不退货只退款;2=已收到货,需退货退款 | | refund\_reason | string | 必须 | 退款原因,可选值为:缺货、未按约定时间发货、收到假货、商品有质量问题、商品错发/漏发、收到的商品破损、收到的商品描述不符、其他 | | refund\_desc | string | 可选 | 退款说明 | ### 请求示例 ``` { "appid": "您的APPID", "version": "v3", "sign_type": "md5", "timestamp": "2020-8-10 12:00:00", "format": "json", "token": "t9oplk489djhn27ebh489kme37yh32j3", "sign": "op0987yhjmngt54rtg2wgdfvcder2765", "params": { "order_id": 123, "refund_total_fee": 220.49, "shipped": 0, "refund_reason": "未收到货,需要退款", "refund_desc": "卖家一直不发货" } } ``` ***** ### 公共返回参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | code | integer必须 | 0=成功,其它值代表请求失败的错误代码,请参考:[公共错误码](response-code.md) | | | message | string | 必须 | 请求成功/失败的描述信息 | | data | array | 必须 | 返回结果,如果没有数据则返回空 | 返回`data`参数格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | refund\_id | integer | 必须 | 退款ID(自增型) | | refund\_sn | string | 必须 | 退款编号唯一性 | ### 返回数据示例 ``` { "code": 0, "message": "成功", "data": { "refund_id": 123 "refund_sn": "202008181750116520" } } ```