退款查询

基本信息

接口名称：	查询退款	状态：	已完成
接口路径：	POST /paas/micro/cashier/queryRefund	更新时间：	2025-03-17 23:27:32
Mock地址：	https://apimock.e-buychina.com/mock/587/paas/micro/cashier/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
cardRefund	object	是		卡支付结果
refundAmount	string	是		退款成功金额	最大长度：10 最小长度：1 Mock：@string
couponRefund	object	是		coupon支付结果
refundAmount	string	是		退款成功金额	最大长度：10 最小长度：1
cashRefund	object	是		积分支付结果
refundAmount	string	是		退款成功金额	最大长度：10 最小长度：1 Mock：@string
thirdRefundOrderId	string	是		渠道退款流水号	最大长度：10 最小长度：1 Mock：@string

备注

查询退款，先交验返回退款状态refundStatus**，再校验返回退款金额refundAmount。以退款金额为最终实际退款金额**

变更历史

变更日期	变更内容
2023-07-31	{"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":{"paymentStatus":{"type":"string","mock":{"mock":"@string"},"minLength":1,"maxLength":64,"description":"交易记录状态Paying支付中/Success成功/Fail失败/SubRefunded部分退款/Refunded已全部退款"},"paymentChannelType":{"type":"string","mock":{"mock":"@string"},"description":"支付渠道","minLength":1,"maxLength":20},"orderId":{"type":"string","mock":{"mock":"@string"},"description":"业务订单 ID","minLength":0,"maxLength":128},"totalAmount":{"type":"number","mock":{"mock":"@natural"},"description":"订单支付总金额"},"currency":{"type":"string","mock":{"mock":"@string"},"description":"币种","minLength":0,"maxLength":5},"outTradeNo":{"type":"string","mock":{"mock":"@string"},"description":"商户交易订单号","minLength":0,"maxLength":50},"paidAmount":{"type":"string","mock":{"mock":"@string"},"description":"支付成功总金额"},"cashPaid":{"type":"string","mock":{"mock":"@string"},"description":"电子钱包支付金额","minLength":0,"maxLength":10},"userPaid":{"type":"string","mock":{"mock":"@string"},"description":"用户实付","minLength":0,"maxLength":50},"merchantAmount":{"type":"number","mock":{"mock":"@float(0, 100, 0, 2)"},"description":"商户实收金额","minimum":0,"exclusiveMinimum":true,"maximum":10,"exclusiveMaximum":true},"paymentTime":{"type":"string","mock":{"mock":"@string"},"description":"支付时间","minLength":0,"maxLength":25},"userInfo":{"type":"object","properties":{"userId":{"type":"string","mock":{"mock":"@string"},"description":"用户id"},"platform":{"type":"string","mock":{"mock":"@string"},"description":"平台标识，枚举"}},"required":["userId","platform"],"description":"消费用户信息"},"cardPaid":{"type":"object","properties":{"paidAmount":{"type":"string","description":"cashcard 支付结果","mock":{"mock":"@string"},"minLength":1,"maxLength":10},"tenderCode":{"type":"string","description":"商户收入映射码","maxLength":20,"minLength":0},"discountCode":{"type":"string","description":"商户优惠映射码","minLength":0,"maxLength":20},"merchantAmount":{"type":"string","description":"商户实收金额","minLength":1,"maxLength":10},"userAmount":{"type":"string","description":"用户实付金额","minLength":1,"maxLength":10},"cardresult":{"type":"array","items":{"type":"string"},"description":"卡使用结果"}},"required":["paidAmount","merchantAmount","userAmount"],"description":"卡支付结果"},"couponPaid":{"type":"object","properties":{"paidAmount":{"type":"string","description":"此资产支付成功金额","minLength":1,"maxLength":10},"tenderCode":{"type":"string","description":"商户收入映射码","minLength":0,"maxLength":20},"discountCode":{"type":"string","description":"商户优惠映射码","minLength":0,"maxLength":20},"merchantAmount":{"type":"string","description":"商户实收金额","minLength":1,"maxLength":10},"userAmount":{"type":"string","description":"用户实付金额","minLength":1,"maxLength":10},"couponresult":{"type":"array","items":{"type":"string","mock":{"mock":"@string"}},"description":"券使用结果"}},"required":["paidAmount","merchantAmount","userAmount"],"description":"coupon支付结果"},"pointsPaid":{"type":"object","properties":{"paidAmount":{"type":"string","mock":{"mock":"@string"},"description":"此资产支付成功金额","minLength":1,"maxLength":10},"pointsCount":{"type":"string","mock":{"mock":"@string"},"description":"使用积分数","minLength":1,"maxLength":10},"tenderCode":{"type":"string","mock":{"mock":"@string"},"description":"商户收入映射码","minLength":0,"maxLength":20},"discountCode":{"type":"string","mock":{"mock":"@string"},"description":"商户优惠映射码","minLength":0,"maxLength":20},"merchantAmount":{"type":"string","description":"商户实收金额","mock":{"mock":"@string"},"minLength":1,"maxLength":10}},"required":["paidAmount","merchantAmount","pointsCount"],"description":"积分支付结果"}},"description":"返回报文","required":["paymentStatus","merchantAmount","totalAmount","outTradeNo","cardPaid","couponPaid","pointsPaid","paidAmount","userInfo","paymentChannelType"]}},"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},"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"}
2023-07-31	{"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},"tradeTime":{"type":"string","mock":{"mock":"@string"},"description":"交易时间,格式YYYYMMDD，不填默认当天","minLength":1,"maxLength":8}},"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":{"paymentStatus":{"type":"string","mock":{"mock":"@string"},"minLength":1,"maxLength":64,"description":"交易记录状态Paying支付中/Success成功/Fail失败/SubRefunded部分退款/Refunded已全部退款"},"paymentChannelType":{"type":"string","mock":{"mock":"@string"},"description":"支付渠道","minLength":1,"maxLength":20},"orderId":{"type":"string","mock":{"mock":"@string"},"description":"业务订单 ID","minLength":0,"maxLength":128},"totalAmount":{"type":"number","mock":{"mock":"@natural"},"description":"订单支付总金额"},"currency":{"type":"string","mock":{"mock":"@string"},"description":"币种","minLength":0,"maxLength":5},"outTradeNo":{"type":"string","mock":{"mock":"@string"},"description":"商户交易订单号","minLength":0,"maxLength":50},"paidAmount":{"type":"string","mock":{"mock":"@string"},"description":"支付成功总金额"},"cashPaid":{"type":"string","mock":{"mock":"@string"},"description":"电子钱包支付金额","minLength":0,"maxLength":10},"userPaid":{"type":"string","mock":{"mock":"@string"},"description":"用户实付","minLength":0,"maxLength":50},"merchantAmount":{"type":"number","mock":{"mock":"@float(0, 100, 0, 2)"},"description":"商户实收金额","minimum":0,"exclusiveMinimum":true,"maximum":10,"exclusiveMaximum":true},"paymentTime":{"type":"string","mock":{"mock":"@string"},"description":"支付时间","minLength":0,"maxLength":25},"userInfo":{"type":"object","properties":{"userId":{"type":"string","mock":{"mock":"@string"},"description":"用户id"},"platform":{"type":"string","mock":{"mock":"@string"},"description":"平台标识，枚举"}},"required":["userId","platform"],"description":"消费用户信息"},"cardPaid":{"type":"object","properties":{"paidAmount":{"type":"string","description":"cashcard 支付结果","mock":{"mock":"@string"},"minLength":1,"maxLength":10},"tenderCode":{"type":"string","description":"商户收入映射码","maxLength":20,"minLength":0},"discountCode":{"type":"string","description":"商户优惠映射码","minLength":0,"maxLength":20},"merchantAmount":{"type":"string","description":"商户实收金额","minLength":1,"maxLength":10},"userAmount":{"type":"string","description":"用户实付金额","minLength":1,"maxLength":10},"cardresult":{"type":"array","items":{"type":"string"},"description":"卡使用结果"}},"required":["paidAmount","merchantAmount","userAmount"],"description":"卡支付结果"},"couponPaid":{"type":"object","properties":{"paidAmount":{"type":"string","description":"此资产支付成功金额","minLength":1,"maxLength":10},"tenderCode":{"type":"string","description":"商户收入映射码","minLength":0,"maxLength":20},"discountCode":{"type":"string","description":"商户优惠映射码","minLength":0,"maxLength":20},"merchantAmount":{"type":"string","description":"商户实收金额","minLength":1,"maxLength":10},"userAmount":{"type":"string","description":"用户实付金额","minLength":1,"maxLength":10},"couponresult":{"type":"array","items":{"type":"string","mock":{"mock":"@string"}},"description":"券使用结果"}},"required":["paidAmount","merchantAmount","userAmount"],"description":"coupon支付结果"},"pointsPaid":{"type":"object","properties":{"paidAmount":{"type":"string","mock":{"mock":"@string"},"description":"此资产支付成功金额","minLength":1,"maxLength":10},"pointsCount":{"type":"string","mock":{"mock":"@string"},"description":"使用积分数","minLength":1,"maxLength":10},"tenderCode":{"type":"string","mock":{"mock":"@string"},"description":"商户收入映射码","minLength":0,"maxLength":20},"discountCode":{"type":"string","mock":{"mock":"@string"},"description":"商户优惠映射码","minLength":0,"maxLength":20},"merchantAmount":{"type":"string","description":"商户实收金额","mock":{"mock":"@string"},"minLength":1,"maxLength":10}},"required":["paidAmount","merchantAmount","pointsCount"],"description":"积分支付结果"}},"description":"返回报文","required":["paymentStatus","merchantAmount","totalAmount","outTradeNo","cardPaid","couponPaid","pointsPaid","paidAmount","userInfo","paymentChannelType"]}},"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":{"paymentStatus":{"type":"string","mock":{"mock":"@string"},"minLength":1,"maxLength":64,"description":"交易记录状态Paying支付中/Success成功/Fail失败/SubRefunded部分退款/Refunded已全部退款"},"paymentChannelType":{"type":"string","mock":{"mock":"@string"},"description":"支付渠道","minLength":1,"maxLength":20},"orderId":{"type":"string","mock":{"mock":"@string"},"description":"业务订单 ID","minLength":0,"maxLength":128},"totalAmount":{"type":"number","mock":{"mock":"@natural"},"description":"订单支付总金额"},"currency":{"type":"string","mock":{"mock":"@string"},"description":"币种","minLength":0,"maxLength":5},"outTradeNo":{"type":"string","mock":{"mock":"@string"},"description":"商户交易订单号","minLength":0,"maxLength":50},"paidAmount":{"type":"string","mock":{"mock":"@string"},"description":"支付成功总金额"},"cashPaid":{"type":"string","mock":{"mock":"@string"},"description":"电子钱包支付金额","minLength":0,"maxLength":10},"userPaid":{"type":"string","mock":{"mock":"@string"},"description":"用户实付","minLength":0,"maxLength":50},"merchantAmount":{"type":"number","mock":{"mock":"@float(0, 100, 0, 2)"},"description":"商户实收金额","minimum":0,"exclusiveMinimum":true,"maximum":10,"exclusiveMaximum":true},"paymentTime":{"type":"string","mock":{"mock":"@string"},"description":"支付时间","minLength":0,"maxLength":25},"userInfo":{"type":"object","properties":{"userId":{"type":"string","mock":{"mock":"@string"},"description":"用户id"},"platform":{"type":"string","mock":{"mock":"@string"},"description":"平台标识，枚举"}},"required":["userId","platform"],"description":"消费用户信息"},"cardPaid":{"type":"object","properties":{"paidAmount":{"type":"string","description":"cashcard 支付结果","mock":{"mock":"@string"},"minLength":1,"maxLength":10},"tenderCode":{"type":"string","description":"商户收入映射码","maxLength":20,"minLength":0},"discountCode":{"type":"string","description":"商户优惠映射码","minLength":0,"maxLength":20},"merchantAmount":{"type":"string","description":"商户实收金额","minLength":1,"maxLength":10},"userAmount":{"type":"string","description":"用户实付金额","minLength":1,"maxLength":10},"cardresult":{"type":"array","items":{"type":"string"},"description":"卡使用结果"}},"required":["paidAmount","merchantAmount","userAmount"],"description":"卡支付结果"},"couponPaid":{"type":"object","properties":{"paidAmount":{"type":"string","description":"此资产支付成功金额","minLength":1,"maxLength":10},"tenderCode":{"type":"string","description":"商户收入映射码","minLength":0,"maxLength":20},"discountCode":{"type":"string","description":"商户优惠映射码","minLength":0,"maxLength":20},"merchantAmount":{"type":"string","description":"商户实收金额","minLength":1,"maxLength":10},"userAmount":{"type":"string","description":"用户实付金额","minLength":1,"maxLength":10},"couponresult":{"type":"array","items":{"type":"string","mock":{"mock":"@string"}},"description":"券使用结果"}},"required":["paidAmount","merchantAmount","userAmount"],"description":"coupon支付结果"},"pointsPaid":{"type":"object","properties":{"paidAmount":{"type":"string","mock":{"mock":"@string"},"description":"此资产支付成功金额","minLength":1,"maxLength":10},"pointsCount":{"type":"string","mock":{"mock":"@string"},"description":"使用积分数","minLength":1,"maxLength":10},"tenderCode":{"type":"string","mock":{"mock":"@string"},"description":"商户收入映射码","minLength":0,"maxLength":20},"discountCode":{"type":"string","mock":{"mock":"@string"},"description":"商户优惠映射码","minLength":0,"maxLength":20},"merchantAmount":{"type":"string","description":"商户实收金额","mock":{"mock":"@string"},"minLength":1,"maxLength":10}},"required":["paidAmount","merchantAmount","pointsCount"],"description":"积分支付结果"}},"description":"返回报文","required":["paymentStatus","merchantAmount","totalAmount","outTradeNo","cardPaid","couponPaid","pointsPaid","paidAmount","userInfo","paymentChannelType"]}},"required":["uuid","action","timestamp","success","errorCode","errorMessage","content"],"description":"ROOT"}
2023-07-31	{"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},"tradeTime":{"type":"string","mock":{"mock":"@string"},"description":"交易时间,格式YYYYMMDD，不填默认当天","minLength":1,"maxLength":8}},"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},"tradeTime":{"type":"string","mock":{"mock":"@string"},"description":"交易时间,格式YYYYMMDD，不填默认当天","minLength":1,"maxLength":8}},"required":["outTradeNo"],"description":"请求报文"}},"required":["uuid","appId","action","timestamp","signType","sign","content","lang"]} {"type":"object","title":"empty object","properties":{}} {"$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":{"paymentStatus":{"type":"string","mock":{"mock":"@string"},"minLength":1,"maxLength":64,"description":"交易记录状态Paying支付中/Success成功/Fail失败/SubRefunded部分退款/Refunded已全部退款"},"paymentChannelType":{"type":"string","mock":{"mock":"@string"},"description":"支付渠道","minLength":1,"maxLength":20},"orderId":{"type":"string","mock":{"mock":"@string"},"description":"业务订单 ID","minLength":0,"maxLength":128},"totalAmount":{"type":"number","mock":{"mock":"@natural"},"description":"订单支付总金额"},"currency":{"type":"string","mock":{"mock":"@string"},"description":"币种","minLength":0,"maxLength":5},"outTradeNo":{"type":"string","mock":{"mock":"@string"},"description":"商户交易订单号","minLength":0,"maxLength":50},"paidAmount":{"type":"string","mock":{"mock":"@string"},"description":"支付成功总金额"},"cashPaid":{"type":"string","mock":{"mock":"@string"},"description":"电子钱包支付金额","minLength":0,"maxLength":10},"userPaid":{"type":"string","mock":{"mock":"@string"},"description":"用户实付","minLength":0,"maxLength":50},"merchantAmount":{"type":"number","mock":{"mock":"@float(0, 100, 0, 2)"},"description":"商户实收金额","minimum":0,"exclusiveMinimum":true,"maximum":10,"exclusiveMaximum":true},"paymentTime":{"type":"string","mock":{"mock":"@string"},"description":"支付时间","minLength":0,"maxLength":25},"userInfo":{"type":"object","properties":{"userId":{"type":"string","mock":{"mock":"@string"},"description":"用户id"},"platform":{"type":"string","mock":{"mock":"@string"},"description":"平台标识，枚举"}},"required":["userId","platform"],"description":"消费用户信息"},"cardPaid":{"type":"object","properties":{"paidAmount":{"type":"string","description":"cashcard 支付结果","mock":{"mock":"@string"},"minLength":1,"maxLength":10},"tenderCode":{"type":"string","description":"商户收入映射码","maxLength":20,"minLength":0},"discountCode":{"type":"string","description":"商户优惠映射码","minLength":0,"maxLength":20},"merchantAmount":{"type":"string","description":"商户实收金额","minLength":1,"maxLength":10},"userAmount":{"type":"string","description":"用户实付金额","minLength":1,"maxLength":10},"cardresult":{"type":"array","items":{"type":"string"},"description":"卡使用结果"}},"required":["paidAmount","merchantAmount","userAmount"],"description":"卡支付结果"},"couponPaid":{"type":"object","properties":{"paidAmount":{"type":"string","description":"此资产支付成功金额","minLength":1,"maxLength":10},"tenderCode":{"type":"string","description":"商户收入映射码","minLength":0,"maxLength":20},"discountCode":{"type":"string","description":"商户优惠映射码","minLength":0,"maxLength":20},"merchantAmount":{"type":"string","description":"商户实收金额","minLength":1,"maxLength":10},"userAmount":{"type":"string","description":"用户实付金额","minLength":1,"maxLength":10},"couponresult":{"type":"array","items":{"type":"string","mock":{"mock":"@string"}},"description":"券使用结果"}},"required":["paidAmount","merchantAmount","userAmount"],"description":"coupon支付结果"},"pointsPaid":{"type":"object","properties":{"paidAmount":{"type":"string","mock":{"mock":"@string"},"description":"此资产支付成功金额","minLength":1,"maxLength":10},"pointsCount":{"type":"string","mock":{"mock":"@string"},"description":"使用积分数","minLength":1,"maxLength":10},"tenderCode":{"type":"string","mock":{"mock":"@string"},"description":"商户收入映射码","minLength":0,"maxLength":20},"discountCode":{"type":"string","mock":{"mock":"@string"},"description":"商户优惠映射码","minLength":0,"maxLength":20},"merchantAmount":{"type":"string","description":"商户实收金额","mock":{"mock":"@string"},"minLength":1,"maxLength":10}},"required":["paidAmount","merchantAmount","pointsCount"],"description":"积分支付结果"}},"description":"返回报文","required":["paymentStatus","merchantAmount","totalAmount","outTradeNo","cardPaid","couponPaid","pointsPaid","paidAmount","userInfo","paymentChannelType"]}},"required":["uuid","action","timestamp","success","errorCode","errorMessage","content"],"description":"ROOT"}
2023-07-31	{"path":"\/queryRefund","params":[]} {"path":"\/queryRefund","params":[]} [] [{"required":"1","name":"Content-Type","value":"application\/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},"tradeTime":{"type":"string","mock":{"mock":"@string"},"description":"交易时间,格式YYYYMMDD，不填默认当天","minLength":1,"maxLength":8}},"required":["outTradeNo"],"description":"请求报文"}},"required":["uuid","appId","action","timestamp","signType","sign","content","lang"]} {} {"type":"object","title":"empty object","properties":{}}

api-id=36114

【主档类】创建租户用户

【主档类】创建租户会员

【主档类】获取用户详情

【主档类】获取会员详情

【资产类】获取会员资产

【资产类】获取会员卡信息

【聚合类】创建用户及会员

【资产类】查询卡券包列表

【资产类】查询卡券来源中文名称

【资产类】通过券码查询thirdOpenId

【资产类】查询单张卡券详情

【通知类】同步天正会员信息并合并资产

签名相关

【聚合类】领取卡券到卡包

【聚合类】激活卡券并插卡包

【聚合类】绑定单卡券到卡包

【安全类】JWT颁发请求令牌

【资产类】卡券包资产整合

【资产类】卡包指定资产移除

【通知类】现金卡状态通知

【通知类】电子券状态通知

【资产类】卡包所有资产移除

【新券标志】查询新券数量

【新券标志】移除新券标志

【资产类】恢复删除的卡券

【通知类】同步卡券产品配置

【转赠】赠送

【转赠】领取

【转赠】撤销

【转赠】查询转赠详情

【转赠】查询卡券转赠记录

【交易类】单卡消费交易

【交易类】当日消费撤销

【交易类】隔日消费退款

查询卡余额

交易记录查询

统一下单

交易查询

申请退款

退款查询

回调外部交易结果通知

获取 TOKEN

拉起收银台插件

查询支付交易结果

交易退款

用户资产查询

获取支付渠道

同步外部订单

物流同步接口

扣款接口

退款

统一下单

支付结果查询

回调外部交易结果通知

预支付接口

支付结果查询-old

退款查询

退款查询

基本信息

请求参数

Headers:

Body:

返回数据

备注

变更历史

No Comments