1. 三方消费
智慧营养健康餐厅
  • 外部接口
    • 三方消费
      • 卡片信息查询
        POST
      • 订单结算
        POST
      • 订单退款
        POST
  1. 三方消费

订单退款

POST
/api/shop/refund

接口概述#

本文档描述了订单退款接口的详细使用方法,包括请求参数、响应格式、错误码说明等信息。

接口信息#

接口地址:https://xxx.com/api/shop/refund
请求方法:POST
Content-Type:application/json
接口版本:v1.0

请求头(Header)#

请求时需要在 Header 中携带以下认证信息:
参数名类型描述示例值
accountString账号account
pwdString密码pwd
keyStringAPI 密钥key

请求参数(Body)#

参数名类型是否必填描述示例值
order_noString是订单号251108114280382
refund_amountString是退款金额(保留两位小数)0.01

响应格式#

退款成功响应#

{
    "code": 0,
    "message": "退款成功",
    "data": {
        "order_no": "251108114280382"
    },
    "trace_id": "690ebaaa5e2cf"
}

退款失败响应#

{
    "code": 1,
    "message": "缺少参数",
    "data": [],
    "trace_id": "692931283c4d6"
}
{
    "code": 1,
    "message": "订单不存在",
    "data": [],
    "trace_id": "692931283c4d6"
}
{
    "code": 1,
    "message": "退款失败",
    "data": [],
    "trace_id": "692931283c4d6"
}
{
    "code": 1,
    "message": "订单不支持退款",
    "data": [],
    "trace_id": "692931283c4d6"
}
{
    "code": 1,
    "message": "可退款金额不足",
    "data": [],
    "trace_id": "692931283c4d6"
}

状态码说明#

状态码描述
0退款成功
1退款失败(通用错误)
说明:状态码为 0 表示成功,非 0 表示失败。

响应字段说明#

字段名类型描述
codeInteger状态码,0 表示成功,非 0 表示失败
messageString响应消息,描述操作结果
dataObject/Array响应数据,成功时包含退款订单号信息
data.order_noString退款订单号,退款成功时返回
trace_idString追踪 ID,用于问题排查

trace_id 说明#

trace_id字段用于接口调用的追踪和问题排查。当接口调用出现问题时,请提供该 ID 以便技术支持人员快速定位问题。

请求参数

Header 参数

Body 参数application/json

示例
{
	"order_no": "251203195059508",
	"refund_amount": "0.98"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location '/api/shop/refund' \
--header 'account: {{account-dev}}' \
--header 'pwd: {{pwd-dev}}' \
--header 'key: {{key-dev}}' \
--header 'Content-Type: application/json' \
--data '{
	"order_no": "251203195059508",
	"refund_amount": "0.98"
}'

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{}
上一页
订单结算
Built with