查询退款订单接口 - 首图支付网关

请求参数

Body 参数application/json

appId

string

应用Id

必需

业务系统的应用Id

channelOrderNo

string

渠道退款订单号

必需

返回支付网关与支付渠道之间的唯一退款订单号，与mchRefundNo二者传一即可

mchRefundNo

string

商户退款单号

必需

业务系统这一笔退款记录的唯一编号，与channelRefundOrderNo二者传一即可

示例

{
    "appId": "Aleph001",
    "channelOrderNo": "R202411291403384691622",
    "mchRefundNo": "R20241521211304000493"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/jiafulai/paymentgateway/api/refund/query' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "Aleph001",
    "channelOrderNo": "R202411291403384691622",
    "mchRefundNo": "R20241521211304000493"
}'

返回响应

🟢200成功

application/json

Body

code

string

返回状态

必需

COMMON_200-处理成功，其他-处理有误，详见错误码

msg

string

返回信息

可选

具体错误原因，例如：签名失败、参数格式校验错误

data

object

返回数据

必需

返回下单数据,json格式数据

channelOrderNo

string

渠道退款订单号

必需

返回支付网关与支付渠道之间的唯一退款订单号，比如与工行聚合支付的退款编号

channelPayOrderNo

string

渠道支付订单号

必需

支付网关与支付渠道之间的唯一订单号

mchRefundNo

string

商户退款单号

必需

业务系统这一笔退款记录的唯一编号

refundMode

string

退款模式

必需

退款模式，整单退款-ENTIRE_REFUND；明细退款-ITEMIZED_REFUND

businessId

string

业务系统费用明细Id

可选

当退款模式为ITEMIZED_REFUND不能为空，

payAmount

string

支付金额

必需

单位分

refundAmount

string

退款金额

必需

单位分

refundState

string

退款状态

必需

退款状态
ORDER_CREATED-订单生成
REFUND_PROGRESS-退款中
REFUND_SUCCESSFUL-退款成功
REFUND_FAILED-退款失败
REFUND_CLOSED-退款关闭

errCode

string

渠道错误码

可选

上游渠道返回的错误码

errMsg

string

渠道错误描述

可选

上游渠道返回的错误描述

createdTime

string

创建时间

必需

退款订单创建时间，13位时间戳

successTime

string

退款成功时间

可选

退款订单退款成功时间，13位时间戳

示例

{
    "code": "string",
    "msg": "string",
    "data": {
        "channelOrderNo": "string",
        "channelPayOrderNo": "string",
        "mchRefundNo": "string",
        "refundMode": "string",
        "businessId": "string",
        "payAmount": "string",
        "refundAmount": "string",
        "refundState": "string",
        "errCode": "string",
        "errMsg": "string",
        "createdTime": "string",
        "successTime": "string"
    }
}