企商通-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.1 红包充值扣减

POST
/api/v1/red_pkg/handle

功能说明#

根据用户授权手机号，给用户充值、扣减红包

应用场景#

根据用户业务场景，需要给用户充值、扣减红包时，可调用此接口

注意事项#

1.
以用户授权手机号作为用户的唯一标识，如果授权手机号不存在时，同步则返回，业务处理失败，用户不存在；
2.
同步请求成功，不代表业务处理成功；实际业务处理结果，应以调用我们对应单据的详情返回的数据为准；
3.
同步请求成功的订单，都会有对应的回调，回调通知频次0s/30s/60s/180s/600s 总计最多5次通知，通知成功后不再重复通知；
4.
用户业务侧，应有对应处理策略，主动调用对应订单详情，来回去最新信息；
5.
订单处理终态：处理成功 或 处理失败，此时意味着订单流程已完结，不会再有任何后续变更；

请求参数

Header 参数
appKey
string 
必需
用户唯一appKey，线下发放
默认值:
{{appKey}}
token
string 
必需
用户token，通过接口获取
默认值:
{{token}}
nonce
string 
每次请求唯一值
必需
默认值:
{{nonce}}
timestamp
string 
必需
请求秒级10位时间戳
默认值:
{{timestamp}}
signature
string 
按规则签名
必需
默认值:
{{signature}}
Body 参数application/json
orderNo
string 
用户业务单号
必需
用户业务侧唯一单号，最大长度32位
amount
integer 
红包金额
必需
单位分
type
integer 
操作类型
必需
1充值，2扣减
phone
string 
手机号
必需
会员手机号
notes
string 
备注信息
可选
备注信息 最大长度200
示例
{
	"orderNo": "24081614184765691872",
	"amount": 123,
	"type": 1,
	"phone": "13888888888",
	"notes": "充值测试"
}

示例代码

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/handle' \
--header 'appKey;' \
--header 'token;' \
--header 'nonce;' \
--header 'timestamp;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
	"orderNo": "24081614184765691872",
	"amount": 123,
	"type": 1,
	"phone": "13888888888",
	"notes": "充值测试"
}'

返回响应

🟢200成功
application/json
Body
status
integer 
状态码
必需
状态码，非200时为业务处理失败
msg
string 
提示信息
必需
提示信息
requestId
string 
唯一追踪id
必需
跟踪id
content
object 
必需
bizOrderNo
string 
平台唯一业务单号
必需
请求单据处理结果详情时，使用
orderNo
string 
用户业务侧唯一单号
必需
示例
{
    "status": 200,
    "msg": "请求成功",
    "requestId": "6a08c214-5b97-11ef-8aa1-8120ad24a2a3",
    "content": {
        "bizOrderNo": "24081614185495366732",
        "orderNo": "24081614184765691872"
    }
}
修改于 2024-08-16 08:00:27
上一页
2 红包
下一页
2.2 红包订单详情
Built with