4.2.2 退款查询

联调环境

https://api.qywh8.com

POST

/openapi/pay/refund/query

退款

请求参数

Body 参数application/json

appId

string

应用APPID

必需

商户应用APPID

subSn

string | null

子商户编码

可选

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

timestamp

string

时间戳

必需

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

requestId

string

请求id

必需

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

signType

string

签名方式

必需

固定值：RSA2

bizContent

object

请求参数

必需

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

mchRefundOrderNo

string

商户退款订单号

可选

refundOrderNo

string

平台退款订单号

可选

sign

string

签名

必需

参照签名方法

示例

{
    "appId": "APP_8428691003",
    "subSn": null,
    "timestamp": "1736153707",
    "requestId": "660b7ffb-eb98-41f9-a831-1b822dff502e",
    "signType": "RSA2",
    "bizContent": {
        "mchOrderNo": "06292e7a-bca5-4d2f-855e-b28f3264d84a",
        "refundOrderNo": "nostrud nulla est"
    },
    "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/query' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "APP_8428691003",
    "subSn": null,
    "timestamp": "1736153707",
    "requestId": "660b7ffb-eb98-41f9-a831-1b822dff502e",
    "signType": "RSA2",
    "bizContent": {
        "mchOrderNo": "06292e7a-bca5-4d2f-855e-b28f3264d84a",
        "refundOrderNo": "nostrud nulla est"
    },
    "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

退款说明

可选

退款说明

successTime

integer

退款成功时间

可选

msg

string

返回信息

必需

appId

string

应用APPID

可选

string

商户编码

可选

sign

string

签名

可选

timestamp

string

时间戳

可选

signType

string

签名方式目前仅支持RSA2

可选

示例

{
    "code": 55,
    "data": {
        "mchOrderNo": "ea eiusmod fugiat non dolor",
        "payOrderNo": "esse Duis aute",
        "mchRefundOrderNo": "cupidatat ut",
        "instOrderNo": "consequat",
        "refundAmount": "303.69",
        "payInfo": "adipisicing nisi eu dolore proident",
        "reason": "magna veniam amet",
        "amount": "386.59",
        "status": "adipisicing velit",
        "message": "nisi",
        "successTime": 1724857833584
    },
    "msg": "reprehenderit et",
    "appId": "6",
    "sn": "in nostrud",
    "sign": "pariatur exercitation reprehenderit cillum et",
    "timestamp": "1736153758",
    "signType": "labore fugiat"
}

4.2.1 实时退款

4.2.3 退款通知