企商通-OpenAPI
  1. 2 红包
企商通-OpenAPI
  • 使用说明
  • 帮助中心
  • 更新说明
  • V1
    • 1 账号信息
      • 1.1 获取 TOKEN
      • 1.2 重置 TOKEN
    • 2 红包
      • 2.1 红包充值扣减
        POST
      • 2.2 红包订单详情
        POST
      • 2.3 红包余额
        POST
      • 2.4 红包变更详情
        POST
    • 3 储值
      • 3.1 储值充值扣减
      • 3.2 储值订单详情
      • 3.3 储值余额
      • 3.4 储值变更详情
  1. 2 红包

2.2 红包订单详情

POST
/api/v1/red_pkg/detail

功能说明#

用户红包充值、扣减订单详情

应用场景#

调用红包充值、扣减接口后,调用此接口返回当前订单的处理详情

注意事项#

单据状态终态为:处理成功、处理失败;终态状态下,订单业务流程完结

请求参数

Header 参数
appKey
string 
必需
用户唯一appKey,线下发放
默认值:
{{appKey}}
token
string 
必需
用户token,通过接口获取
默认值:
{{token}}
nonce
string 
每次请求唯一值
必需
默认值:
{{nonce}}
timestamp
string 
必需
请求秒级10位时间戳
默认值:
{{timestamp}}
signature
string 
按规则签名
必需
默认值:
{{signature}}
Body 参数application/json
bizOrderNo
string 
平台唯一业务单号
必需
平台唯一业务单号
示例
{
    "bizOrderNo":"24081614185495366732"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test-openapi.qstsc.com/api/v1/red_pkg/detail' \
--header 'appKey;' \
--header 'token;' \
--header 'nonce;' \
--header 'timestamp;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bizOrderNo":"24081614185495366732"
}'

返回响应

🟢200成功
application/json
Body
status
integer 
状态码
必需
业务请求状态码,非200为失败
msg
string 
提示信息
必需
requestId
string 
跟踪id
必需
问题排查时,请提供此id
content
object 
必需
bizOrderNo
string 
平台业务单号
必需
平台唯一业务单号
orderNo
string 
用户业务单号
必需
type
integer 
操作类型
必需
1充值,2扣减
typeCn
string 
类型描述
必需
phone
string 
手机号
必需
amount
integer 
金额
必需
单位 分
notes
string 
备注信息
必需
status
integer 
状态
必需
1待处理,2处理中,3处理成功,4处理失败
statusCn
string 
状态描述
必需
errMsg
string 
提示信息
必需
处理失败时,失败原因
createTime
string 
申请时间
必需
createTimeCn
string 
申请时间描述
必需
示例
{
    "status": 200,
    "msg": "请求成功",
    "requestId": "c4dca3d6-5b9c-11ef-b0c0-9302770860f5",
    "content": {
        "bizOrderNo": "24081614185495366732",
        "orderNo": "24081614184765691872",
        "type": 1,
        "typeCn": "增加",
        "phone": "13888888888",
        "amount": 123,
        "notes": "充值测试",
        "status": 1,
        "statusCn": "待处理",
        "errMsg": "",
        "createTime": "1723789134",
        "createTimeCn": "2024-08-16 14:18:54"
    }
}
修改于 2024-08-16 10:30:27
上一页
2.1 红包充值扣减
下一页
2.3 红包余额
Built with