4.2.1 实时退款

联调环境

POST

/openapi/pay/refund

退款

1、功能说明
（1）退款规则：原交易存在、且原交易可退金额大于等于本次退款金额、且商户当日正向交易头寸大于等于本次退款金额。
（2）支持部分退款、全额退款。

请求参数

Body 参数application/json

appId

string

应用APPID

必需

商户应用APPID

subSn

string | null

子商户编码

可选

非必传项，目前仅代理商/服务商可传，普通商户和平台商户请勿传入

timestamp

string

时间戳

必需

请求时间戳单位秒，要求timestamp与当前时间间隔在60秒以内

requestId

string

请求id

必需

请求唯一标识，无其他意义，必须每一次请求不允许重复，用于定位问题

signType

string

签名方式

必需

固定值：RSA2

bizContent

object

请求参数

必需

由于工具限制，该字段必须转为JSON 格式字符串，请注意

mchOrderNo

string

商户订单号

可选

payOrderNo

string

平台订单号

可选

mchRefundOrderNo

string

商户退款订单号

必需

amount

string

退款金额

必需

单位元

reason

string

退款原因

可选

notifyUrl

string

通知地址

可选

退款结果异步通知地址

acctInfos

array [object {3}]

退款分账串

可选

如果是分账订单，需要退分账此处必填

sign

string

签名

必需

参照签名方法

示例

{
  "appId": "APP_8428691003",
  "subSn": "voluptate exercitation occaecat commodo nostrud",
  "timestamp": "1736153482",
  "requestId": "2934770c-386f-42e0-b183-ec765854f2c7",
  "signType": "RSA2",
  "bizContent": {
    "mchOrderNo": "d9f8dc20-095b-47e1-b5a9-6b097e7944d0",
    "payOrderNo": "ut laborum labore consectetur",
    "mchRefundOrderNo": "nulla sunt",
    "amount": "0.1"
  },
  "sign": "H6oAMOljItjCsEC72RmZ/s9VFg/BFZbv3oPtUKjoM7w3jeNgCLOrFASD0o3Qbesnd9xkCbT62IJt/sNBvs47ja02X2QGBYg5+aXIZ6zn6Uu+HegqdMYBTtjrY3t2sBHVr+QK5mZo59Ic7baVEz4NTBkS/BPbtlrwIvbcqq9quSZ5vCyBt/nkXUNy0JgxtzCofwT8I4pKWUQcWovI+AIt/a0wW8VOcoKA+vif4DmiNK0BitypOYpr4aFDZodj8DYdBRXQFA12KRCk1q3HERvQSLE33FAg+xF+LOKy2zLucqdjgzBSwne0CVOhjKDXU9EdQO1bH+fRam9A83HT0sUJsw=="
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.qywh8.com/openapi/pay/refund' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "APP_8428691003",
    "subSn": "voluptate exercitation occaecat commodo nostrud",
    "timestamp": "1736153482",
    "requestId": "2934770c-386f-42e0-b183-ec765854f2c7",
    "signType": "RSA2",
    "bizContent": {
        "mchOrderNo": "d9f8dc20-095b-47e1-b5a9-6b097e7944d0",
        "payOrderNo": "ut laborum labore consectetur",
        "mchRefundOrderNo": "nulla sunt",
        "amount": "0.1"

    },
    "sign": "H6oAMOljItjCsEC72RmZ/s9VFg/BFZbv3oPtUKjoM7w3jeNgCLOrFASD0o3Qbesnd9xkCbT62IJt/sNBvs47ja02X2QGBYg5+aXIZ6zn6Uu+HegqdMYBTtjrY3t2sBHVr+QK5mZo59Ic7baVEz4NTBkS/BPbtlrwIvbcqq9quSZ5vCyBt/nkXUNy0JgxtzCofwT8I4pKWUQcWovI+AIt/a0wW8VOcoKA+vif4DmiNK0BitypOYpr4aFDZodj8DYdBRXQFA12KRCk1q3HERvQSLE33FAg+xF+LOKy2zLucqdjgzBSwne0CVOhjKDXU9EdQO1bH+fRam9A83HT0sUJsw=="
}'

返回响应

🟢200OK

application/json

Body

code

integer

请求状态

必需

返回200=成功，其他状态均为失败

data

object

返回数据体

可选

mchOrderNo

string

商户订单号

必需

payOrderNo

string

平台订单号

必需

mchRefundOrderNo

string

商户退款订单号

可选

号

instOrderNo

string

平台退款订单号

可选

refundAmount

string

退款金额

可选

单位元

payInfo

string

订单金额

可选

单位元

reason

string

退款原因

可选

amount

string

订单金额

必需

单位元

status

string

退款状态

必需

1 初始化 2 退款中 3 退款完成 4 退款失败

message

string

退款说明

可选

退款说明

msg

string

返回信息

必需

appId

string

应用APPID

可选

string

商户编码

可选

sign

string

签名

可选

timestamp

string

时间戳

可选

signType

string

签名方式目前仅支持RSA2

可选

示例

{
  "code": 94,
  "data": {
    "mchOrderNo": "commodo nulla",
    "payOrderNo": "id Duis sunt",
    "mchRefundOrderNo": "est dolore ad cupidatat",
    "instOrderNo": "incididunt exercitation Excepteur et",
    "refundAmount": "142.59",
    "payInfo": "proident amet dolor pariatur cillum",
    "reason": "pariatur aute proident irure deserunt",
    "amount": "184.29",
    "status": "Excepteur reprehenderit",
    "message": "eu"
  },
  "msg": "est ut ex",
  "appId": "9",
  "sn": "magna irure est",
  "sign": "dolore exercitation in velit ad",
  "timestamp": "1736153646",
  "signType": "nulla proident dolor"
}

4.1.4 交易结果通知

4.2.2 退款查询