接口介绍

退款接口。

参数简介

公共参数

参数名 参数类型 参数介绍 是否必填
command String(32) 接口名,固定为:open.api.device.refund
app_id String(32) 应用ID
device_no String(32) 设备唯一标识
version String(16) 调用的接口版本,固定为:1.0
sign_type String(32) 签名类型 固定为:MD5
request_id String(64) 请求报文ID,唯一定位一次报文请求,由发起方生成,应答方原样返回,uuid生成,全局唯一
request_time String(32) 请求发起时间,格式:yyyyMMddHHmmss,请求发起时间,应答方原样返回
sign String(32) 签名,详见MD5签名

参数简介

参数名 参数类型 参数介绍 是否必填
local_order_no String(64) 接入方的本地订单号 特殊可选,与cb_order_no二选一
cb_order_no String(64) 采宝订单号 特殊可选,与local_order_no二选一,优先级:cb_order_no > local_order_no
local_refund_no String(64) 接入方的本地退款订单号
refund_amount Long 退款金额,如果为空,那么默认全部退款
reason String(128) 退款原因,小于128个字符

返回值说明

公共返回值

参数名 所属结构 返回值类型 返回值说明 特殊备注
success result boolean 标识这次请求是否成功 请不要用这个值来判断收银是否成功,订单的结果以返回的refund_status为准。
error_code result String 错误码
error_msg result String 错误码的详细说明
app_id data String(32) 应用ID
device_no data String(64) 设备唯一标识
request_id data String(64) 请求报文ID
request_time data String(32) 请求发起时间,格式:yyyyMMddHHmmss
response_time data String(32) 请求返回时间,格式:yyyyMMddHHmmss
sign sign String 签名值 具体参照: 接口验签规则

数据返回值

参数名 所属结构 返回值类型 返回值说明 特殊备注
local_order_no data String(64) 本地订单号
cb_order_no data String(64) 采宝的订单号,最长64位
out_order_no data String(64) 支付宝、微信等的订单号id,最长64位
refund_status data String(64) 订单状态 参与签名,该状态用于判断退款是否成功,具体取值请参照:名词解释
refund_amount data long 退款金额(分为单位)

返回值举例

{
    "data": {
        "app_id":"BOPU",
        "device_no":"1234566",
        "cb_order_no": "TCRWX1809271811012351450",
        "local_order_no": "OPENAPIR201809271810532729481",
        "out_order_no": "4200000188201809277120615322",
        "refund_amount": 1,
        "refund_status": "REFUND_SUC",
        "request_id": "b756648e-c7b8-413e-899d-4ffcfe2c32e0",
        "request_time": "20180927181053",
        "response_time": "20180927181058"
    },
    "result": {
        "success": true
    },
    "sign": "gI3XFpiih5KbU1XDKQbwGGlubcF37L2caT5Ragwc4o+p4Xl2E7sndMtC8frSYojlCH354H0RXRPIV2QVOqkA98Fl/DsGkLpdJmPfGd3NnudUbqL+YfSntsMN/HXpDGmQEpi9IHo0FzgoWIy14LXUWGwcAaFS2Y2El/dV7YowaF12EKAg4j3LPhB7jn1z9WZ54//VTQCw3zhW0Ue6JgmpazpkefhG4F85wSJLI73x78L7L1fJEmQ12gad485c1WwAj0gO8lJOoul30xPfrhVVUTJPooDBn08lxE53ePXovB9my587EQyVcTjVoOciOOgCvrnFDtwyiz4TGFlTQHFIpA=="
}

Js Demo

http://openapi.caibaopay.com/test/api/device/refund.htm

results matching ""

    No results matching ""