向个人收银 (C2B 支付)
接口列表
同步退款订单

同步退款订单

将客户原支付系统的退款订单同步到腾讯云商付系统里

接口说明

请求方式:
post
https://p.wecard.tencent.com/cloudpay/v1/pay/sync/refund_order

请求参数

Request
Body 包体
OutRefundId必填
string

退款外部订单号,即业务系统侧退款订单号;
只能是数字、大小写字母、下划线;且在同一个主体下唯一,同一退款单号多次请求只退一笔。

最小长度:6     最大长度:32

OutOrderId必填
string

外部订单号,即业务系统侧订单

最小长度:6     最大长度:60

ThirdRefundId选填
string

收单渠道退款单号,如微信、支付宝作为收单收单机构时的微信或支付宝退款单号


RefundAmount必填
integer

退款金额;单位:分。支持部分退款


Remark选填
string

退款备注

最小长度:0     最大长度:128

RefundReason选填
string

退款原因

最小长度:0     最大长度:128

ExternalRefundData选填
string

退款渠道扩展字段,第三方通道的扩展信息,根据具体对接的渠道情况传值; 该字段为 json 序列化之后的字符串

最小长度:0     最大长度:1000

FundAllocateList选填
array

退挂账信息。支付通道耦合银行账户体系时必填,否则不用。

数组子类型:object


ProductList选填
array

商品列表

数组子类型:object


ProfitShareInfoList选填
array

分账信息列表

数组子类型:object


WalletRefundInfo选填
object

钱包信息,储值余额退款可传


CreateTime必填
string

退款创建时间,yyyy-MM-dd HH:mm:ss格式


FinishTime必填
string

退款完成时间,yyyy-MM-dd HH:mm:ss格式


FeeAmount选填
integer

退款手续费,单位分


IsFeeUpdated选填
boolean

是否同步手续费,如果为true,需要传入手续费

请求示例

{
  "OutOrderId": "orderid202211200001",
  "OutRefundId": "refundId202211200001",
  "RefundAmount": 1000,
  "ThirdRefundId": "thirdRefundId1234567890",
  "RefundReason": "用户退货",
  "Remark": "test"
}

返回参数

Response
Response必填
object

返回示例

{
  "Response": {
    "RequestId": "xxxxxxxxx",
    "Result": {
      "OutRefundId": "ottorefund00007",
      "OutOrderId": "otto202211250005",
      "RefundStatus": "PROCESSING",
      "RefundMessage": "退款中",
      "RefundAmount": "1000"
    },
    "ErrCode": "SUCCESS",
    "ErrMessage": "成功"
  }
}

ErrCode 码表

错误代码描述解决方案
SUCCESS请求成功需根据 Result 中 RefundStatus 字段判断退款状态
FailedOperation.SystemError系统未知异常请稍后重试,或进行查单和回调通知确认退款退款订单状态
ORDER.INVALID_PARAMETER参数有误请根据返回描述修正请求参数
ORDER.OPERATE_IS_PROCESSING订单存在并发操作当前支付订单同时存在别的请求操作(如退款、关单等),请稍后重试
ORDER.ORDER_CANNOT_REFUND订单无法退款请确认支付订单状态 ,状态为成功或部分退款才允许退款
ORDER.REFUND_AMOUNT_EXCEED累计退款金额大于订单金额请检查当前支付订单累计退款金额,是否大于支付订单金额
REFUND.APPLY_NOT_PROCESSED已存在退款中订单当前这笔支付订单,存在退款中的订单,请先等上一笔退款订单完结再发起
ORDER.THIS_RECORD_ALREADY_EXISTED该退款流水已存在当前退款流水记录已存在,且已经为成功、失败的终态,请调用查询接口同步状态
ChannelOperationError下游银行通道业务错误下游通道返回的业务错误,详细原因请参考接口返回的 ErrMessage,请稍后重试

同步退款订单响应处理流程参考退款申请的响应处理,如下


腾讯云商付接口文档