接口介绍
退款接口。
参数简介
| 参数名 |
参数类型 |
参数介绍 |
是否必填 |
是否参与签名 |
| command |
String(32) |
接口名，用于标识调用哪个接口，交易退款：open.pay.refund |
是 |
否 |
| operator_id |
String(32) |
收银员的id，用于标识收款账户 |
是 |
是 |
| app |
String(32) |
接入商标识 |
是 |
是 |
| sign |
String(32) |
签名，详见请求签名规则 |
是 |
否 |
| local_order_no |
String(64) |
接入方的本地订单号 |
否，与order_no二选一 |
是 |
| order_no |
String(64) |
采宝订单号 |
否，与local_order_no二选一，优先级：order_no > local_order_no |
是 |
| timestamp |
Long |
时间戳，值为当前时间距离19700101的毫秒数 |
是 |
是 |
| refund_amount |
Long |
退款金额，如果为空，那么默认全部退款 |
否 |
否 |
| reason |
String(32) |
退款原因 |
否 |
是 |
返回值说明
| 参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
| success |
result |
boolean |
标识这次请求是否成功 |
请不要用这个值来判断退款是否成功。 |
| errorCode |
result |
String |
错误码 |
|
| errorMsg |
result |
String |
错误码的详细说明 |
|
| localOrderNo |
data |
String |
本地订单号 |
参与签名 |
| cbOrderNo |
data |
String(64) |
采宝的订单号，最长64位 |
参与签名 |
| outOrderNo |
data |
String(64) |
支付宝、微信等的订单号id，最长64位 |
参与签名 |
| refundStatus |
data |
int |
订单状态 |
参与签名，该状态用于判断退款是否成功，具体取值请参照：名词解释 |
| refundAmount |
data |
long |
退款金额（分为单位） |
参与签名 |
| sign |
data |
String |
签名值 |
具体参照: 接口返回值的安全校验规则 |
| timestamp |
data |
String |
时间戳 |
参与签名 |
返回值举例
{
"result": {
"success": false,
"errorCode":"10",
"errorMsg": "command参数为空"
}
"data":{
"refundStatus":"", ##退款状态，参与签名
"localOrderNo":"",##本地退款订单号，参与签名
"cbOrderNo":"",##采宝的订单号，参与签名
"outOrderNo":"", ##支付宝，微信等的外部订单号，参与签名
"refundAmount":"" ##退款金额，参与签名
,"sign":"" ## 签名值
,"timestamp":"" ## 时间戳，参与签名
}
}
js demo
https://openapi.caibaopay.com/test/api/refund.htm