Skip to main content
e-Buy Docs
View All
Search
Shelves
Books
Log in
Info
Content
Books
e-Buy PaaS API
线上支付API
退款查询
退款查询
基本信息
接口名称:
退款查询
状 态:
已完成
接口路径:
POST
/api/queryRefund
更新时间:
2025-03-17 23:57:22
Mock地址:
https://apimock.e-buychina.com/mock/713/api/queryRefund
请求参数
Headers:
参数名称
参数值
是否必填
Content-Type
application/json
是
Body:
参数名称
类型
必填
默认值
备注
其他信息
uuid
string
是
请求序列号
最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appId
string
是
请求AppId
最大长度:50
最小长度:1
Mock:@natural
action
string
是
交易类型
最大长度:50
最小长度:1
Mock:queryRefund
timestamp
number
是
请求时间戳
Mock:@timestamp
signType
string
是
签名类型
最大长度:20
最小长度:1
Mock:sha256
sign
string
是
签名值
最大长度:500
最小长度:1
Mock:@natural
lang
string
是
语言
最大长度:50
最小长度:1
Mock:zh_CN
content
object
是
请求报文
outTradeNo
string
是
外部订单号。如果商户同时使用多个渠道,可以选用最小值
最大长度:32
最小长度:32
Mock:@natural(32, 128)
refundTradeNo
string
否
退款请求流水号
最大长度:32
最小长度:32
Mock:@string
返回数据
参数名称
类型
必填
默认值
备注
其他信息
uuid
string
是
请求序列号
最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
success
boolean
是
查询请求是否成功,不代表源交易成功与否。
Mock:@boolean
action
string
是
交易类型
最大长度:50
最小长度:1
Mock:queryRefund
timestamp
number
是
返回时间戳
Mock:@timestamp
errorCode
string
是
错误码
最大长度:50
Mock:@word
errorMessage
string
是
错误描述
最大长度:50
Mock:@csentence
signType
string
否
签名类型
最大长度:20
Mock:sha256
sign
string
否
签名值
最大长度:500
Mock:@natural
content
object
是
返回报文
refundStatus
string
是
交易记录状态Paying支付中
Success成功
Fail失败
SubRefunded部分退款
Refunded已全部退款
最大长度:64
最小长度:1
Mock:@string
refundTradeNo
string
是
退款流水号
最大长度:64
最小长度:1
Mock:@string
refundAmount
number
是
总退款金额
Mock:@natural
currency
string
否
币种
最大长度:5
Mock:@string
outTradeNo
string
是
商户交易订单号
最大长度:50
Mock:@string
cashRefund
object
是
支付退款结果
refundAmount
string
是
退款成功金额
最大长度:10
最小长度:1
Mock:@string
thirdRefundOrderId
string
是
渠道退款流水号
最大长度:10
最小长度:1
Mock:@string
备注
查询退款,先交验返回退款状态
refundStatus**,再校验返回退款金额
refundAmount
。以退款金额为最终实际退款金额**
变更历史
变更日期
变更内容
2025-03-17
{"path":"\/queryRefund","params":[]}
{"path":"\/queryRefund","params":[]}
[{"required":"1","name":"Content-Type","value":"application\/json"}]
[{"required":"1","name":"Content-Type","value":"application\/json"}]
{"req_body_type":"json"}
{"req_body_type":"json"}
{"res_body_type":"json"}
{"res_body_type":"json"}
{"type":"object","title":"empty object","properties":{"uuid":{"type":"string","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"},"description":"请求序列号","minLength":1,"maxLength":50},"appId":{"type":"string","mock":{"mock":"@natural"},"description":"请求AppId","minLength":1,"maxLength":50},"action":{"type":"string","mock":{"mock":"queryRefund"},"description":"交易类型","minLength":1,"maxLength":50},"timestamp":{"type":"number","mock":{"mock":"@timestamp"},"description":"请求时间戳","minimum":1,"exclusiveMinimum":true,"maximum":14,"exclusiveMaximum":true},"signType":{"type":"string","mock":{"mock":"sha256"},"description":"签名类型","minLength":1,"maxLength":20},"sign":{"type":"string","mock":{"mock":"@natural"},"description":"签名值","minLength":1,"maxLength":500},"lang":{"type":"string","mock":{"mock":"zh_CN"},"description":"语言","minLength":1,"maxLength":50},"content":{"type":"object","properties":{"outTradeNo":{"type":"string","description":"外部订单号。如果商户同时使用多个渠道,可以选用最小值","mock":{"mock":"@natural(32, 128)"},"minLength":32,"maxLength":32},"refundTradeNo":{"type":"string","mock":{"mock":"@string"},"description":"退款请求流水号","minLength":32,"maxLength":32}},"required":["outTradeNo"],"description":"请求报文"}},"required":["uuid","appId","action","timestamp","signType","sign","content","lang"]}
{"type":"object","title":"empty object","properties":{"uuid":{"type":"string","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"},"description":"请求序列号","minLength":1,"maxLength":50},"appId":{"type":"string","mock":{"mock":"@natural"},"description":"请求AppId","minLength":1,"maxLength":50},"action":{"type":"string","mock":{"mock":"queryRefund"},"description":"交易类型","minLength":1,"maxLength":50},"timestamp":{"type":"number","mock":{"mock":"@timestamp"},"description":"请求时间戳","minimum":1,"exclusiveMinimum":true,"maximum":14,"exclusiveMaximum":true},"signType":{"type":"string","mock":{"mock":"sha256"},"description":"签名类型","minLength":1,"maxLength":20},"sign":{"type":"string","mock":{"mock":"@natural"},"description":"签名值","minLength":1,"maxLength":500},"lang":{"type":"string","mock":{"mock":"zh_CN"},"description":"语言","minLength":1,"maxLength":50},"content":{"type":"object","properties":{"outTradeNo":{"type":"string","description":"外部订单号。如果商户同时使用多个渠道,可以选用最小值","mock":{"mock":"@natural(32, 128)"},"minLength":32,"maxLength":32},"refundTradeNo":{"type":"string","mock":{"mock":"@string"},"description":"退款请求流水号","minLength":32,"maxLength":32}},"required":["outTradeNo"],"description":"请求报文"}},"required":["uuid","appId","action","timestamp","signType","sign","content","lang"]}
{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"请求序列号","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"}},"success":{"type":"boolean","description":"查询请求是否成功,不代表源交易成功与否。","mock":{"mock":"@boolean"}},"action":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"交易类型","mock":{"mock":"queryRefund"}},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"}},"errorCode":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误码","mock":{"mock":"@word"}},"errorMessage":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误描述","mock":{"mock":"@csentence"}},"signType":{"type":"string","default":"","minLength":0,"maxLength":20,"description":"签名类型","mock":{"mock":"sha256"}},"sign":{"type":"string","default":"","minLength":0,"maxLength":500,"description":"签名值","mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"refundStatus":{"type":"string","mock":{"mock":"@string"},"minLength":1,"maxLength":64,"description":"交易记录状态Paying支付中/Success成功/Fail失败/SubRefunded部分退款/Refunded已全部退款"},"refundTradeNo":{"type":"string","mock":{"mock":"@string"},"description":"退款流水号","minLength":1,"maxLength":64},"refundAmount":{"type":"number","mock":{"mock":"@natural"},"description":"总退款金额","minimum":1,"exclusiveMinimum":true,"maximum":10,"exclusiveMaximum":true},"currency":{"type":"string","mock":{"mock":"@string"},"description":"币种","minLength":0,"maxLength":5},"outTradeNo":{"type":"string","mock":{"mock":"@string"},"description":"商户交易订单号","minLength":0,"maxLength":50},"cardRefund":{"type":"object","properties":{"refundAmount":{"type":"string","description":"退款成功金额","mock":{"mock":"@string"},"minLength":1,"maxLength":10}},"required":["refundAmount"],"description":"卡支付结果"},"couponRefund":{"type":"object","properties":{"refundAmount":{"type":"string","description":"退款成功金额","minLength":1,"maxLength":10}},"required":["refundAmount"],"description":"coupon支付结果"},"cashRefund":{"type":"object","properties":{"refundAmount":{"type":"string","mock":{"mock":"@string"},"description":"退款成功金额","minLength":1,"maxLength":10},"thirdRefundOrderId":{"type":"string","mock":{"mock":"@string"},"description":"渠道退款流水号","minLength":1,"maxLength":10}},"required":["refundAmount","thirdRefundOrderId"],"description":"积分支付结果"}},"description":"返回报文","required":["refundStatus","refundAmount","outTradeNo","cardRefund","couponRefund","cashRefund","refundTradeNo"]}},"required":["uuid","action","timestamp","success","errorCode","errorMessage","content"],"description":"ROOT"}
{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"uuid":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"请求序列号","mock":{"mock":"@now(\'yyyyMMdd\')-@string(\'lower\',32)"}},"success":{"type":"boolean","description":"查询请求是否成功,不代表源交易成功与否。","mock":{"mock":"@boolean"}},"action":{"type":"string","default":"","minLength":1,"maxLength":50,"description":"交易类型","mock":{"mock":"queryRefund"}},"timestamp":{"type":"number","description":"返回时间戳","mock":{"mock":"@timestamp"}},"errorCode":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误码","mock":{"mock":"@word"}},"errorMessage":{"type":"string","default":"","minLength":0,"maxLength":50,"description":"错误描述","mock":{"mock":"@csentence"}},"signType":{"type":"string","default":"","minLength":0,"maxLength":20,"description":"签名类型","mock":{"mock":"sha256"}},"sign":{"type":"string","default":"","minLength":0,"maxLength":500,"description":"签名值","mock":{"mock":"@natural"}},"content":{"type":"object","properties":{"refundStatus":{"type":"string","mock":{"mock":"@string"},"minLength":1,"maxLength":64,"description":"交易记录状态Paying支付中/Success成功/Fail失败/SubRefunded部分退款/Refunded已全部退款"},"refundTradeNo":{"type":"string","mock":{"mock":"@string"},"description":"退款流水号","minLength":1,"maxLength":64},"refundAmount":{"type":"number","mock":{"mock":"@natural"},"description":"总退款金额","minimum":1,"exclusiveMinimum":true,"maximum":10,"exclusiveMaximum":true},"currency":{"type":"string","mock":{"mock":"@string"},"description":"币种","minLength":0,"maxLength":5},"outTradeNo":{"type":"string","mock":{"mock":"@string"},"description":"商户交易订单号","minLength":0,"maxLength":50},"cashRefund":{"type":"object","properties":{"refundAmount":{"type":"string","mock":{"mock":"@string"},"description":"退款成功金额","minLength":1,"maxLength":10},"thirdRefundOrderId":{"type":"string","mock":{"mock":"@string"},"description":"渠道退款流水号","minLength":1,"maxLength":10}},"required":["refundAmount","thirdRefundOrderId"],"description":"支付退款结果"}},"description":"返回报文","required":["refundStatus","refundAmount","outTradeNo","cashRefund","refundTradeNo"]}},"required":["uuid","action","timestamp","success","errorCode","errorMessage","content"],"description":"ROOT"}
api-id=37488
entities.pages_pointer_enter_mode
Previous
申请退款
Next
回调外部交易结果通知
No Comments
Add Comment
New Comment
In reply to 1234
Remove
Cancel
Save Comment
Back to top
Entity Select
No Comments