查询 - Refund query

请求地址

https://{{gateway_domain}}/pg/v2/refund/query

请求参数

HTTP Method

POST

HTTP Header

字段	数据类型	长度限制	是否必填项	说明
Content-Type	String	N/A	是	字段值只支持 application/json
Accept	String	N/A	是	字段值只支持 application/json
Authorization	String		是	Authorization: {type} {credentials}，详情参考签名规范部分

HTTP Body

字段	数据类型	长度限制	是否必填项	说明
merchantRefundNo	String	50	否	商户退款订单号，与 refundNo 二选一，不能同时为空
refundNo	String	32	否	退款流水号，与 merchantRefundNo 二选一，不能同时为空

参数说明

merchantRefundNo 和 refundNo 两个参数不能同时为空，至少需要提供其中一个来查询退款信息。

响应结果

HTTP Header

字段	数据类型	是否必填项	说明
Content-Type	String	是	字段值只支持 application/json
Authorization	String	是	Authorization: {type} {credentials}，详情参考签名规范部分

HTTP Body

字段	数据类型	是否必填项	说明
code	String	是	响应状态码
errorMessage	String	否	错误信息
data	JSON Object	否	响应数据

data 字段说明

字段	数据类型	是否必填项	说明
refundNo	String	是	退款平台流水号
disputeNo	String	否	如果是争议退款，则返回争议号
paymentNo	String	是	支付平台交易流水号
merchantRefundNo	String	是	商户退款订单号
bankRefundNo	String	否	银行退款号
rrn	String	否	渠道检索参考号码
status	String	是	退款状态
refundSource	String	是	退款来源
refundAmount	String	是	退款金额
currency	String	是	退款币种
createdTime	String	是	退款创建时间

示例

请求示例 1：通过商户退款订单号查询

curl https://{{gateway_domain}}/pg/v2/refund/query \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H 'Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=9e494e8a91bcdd08f18ad5b2cfdbfd5654f5c00c89f8216eebd7c1637b6ce01b,timestamp=1714128828114,nonce=C7CA27DC6D55DA935DFC8450C721CC99' \
  -d '{
  "merchantRefundNo": "REFUND-001"
}'

请求示例 2：通过平台退款流水号查询

curl https://{{gateway_domain}}/pg/v2/refund/query \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H 'Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=9e494e8a91bcdd08f18ad5b2cfdbfd5654f5c00c89f8216eebd7c1637b6ce01b,timestamp=1714128828114,nonce=C7CA27DC6D55DA935DFC8450C721CC99' \
  -d '{
  "refundNo": "20240423220624300800001097000004"
}'

响应

HTTP/1.1 200 OK
Content-Type: application/json
Server: nginx/1.18.0
Date: Mon, 06 Mar 2024 12:00:00 GMT
Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=ac6ae72f8c46f5c2092c3dab9bb0e08b6cdb6d5e7ff8ad190499a8955d57f297,timestamp=1714128245401,nonce=28FA11BF8FD1309767551B4FD8A57BD5

{
    "code": "OK",
    "errorMessage": null,
    "data": {
        "refundNo": "20240423220624300800001097000005",
        "disputeNo": null,
        "paymentNo": "20240423220624300800001097000004",
        "merchantRefundNo": "REFUND-001",
        "bankRefundNo": "BK20240423001",
        "rrn": "123456789012",
        "status": "REFUNDING",
        "refundSource": "DEFAULT",
        "refundAmount": "50.00",
        "currency": "INR",
        "createdTime": "2024-04-23T22:10:45+08:00"
    }
}

退款状态

状态	说明
REFUNDING	退款中
SUCCEED	退款成功
FAILED	退款失败
CANCELLED	退款取消
REVERSED	退款撤销/冲正

退款来源

来源	说明
DEFAULT	默认退款
DISPUTE	争议退款
MERCHANT	商户退款
PLATFORM	平台退款