商起点开放平台 API 文档

商起点开放平台为第三方 App 开发者提供商户经营管理能力的 RESTful API。通过接入本平台,您的 App 可以实现商户管理、商品管理、订单处理、会员卡、优惠券、预约、支付等完整的商业闭环功能。

基础信息

  • Base URL: https://{domain}/open-api
  • 数据格式: JSON
  • 字符编码: UTF-8
  • 版本: v1.0
  • 接口总数: ~146 个

接入准备

  1. 在商起点运营后台注册开发者账号
  2. 创建应用,获取 AppKeyAppSecret
  3. 配置 IP 白名单(可选)
  4. 申请所需的 API 权限模块

接口总览

模块接口数量权限模块
商户数据13merchant
商品数据15product
订单数据15order
会员卡数据14member_card
优惠券21coupon
抵金券9cash_voucher
客户管理9customer
可预订资源11resource
预约数据10booking
支付(收银台)2payment
提现5withdraw
B2B转账2transfer
固定收款码3
数据统计7statistics
实名认证4real_name_auth
支付宝授权4alipay_auth
风控模型2risk

鉴权机制

所有 API 请求必须携带以下 HTTP 请求头:

请求头说明示例
X-App-Key应用标识app_abc123
X-Timestamp当前时间戳(秒级)1713254400
X-Nonce随机字符串(防重放)a1b2c3d4e5
X-SignHMAC-SHA256 签名Base64编码的签名

签名算法

签名计算方式
签名原文 = AppKey + Timestamp + Nonce + RequestBody
X-Sign = Base64( HMAC-SHA256( AppSecret, 签名原文 ) )

⚠️ 安全策略

  • 时间戳有效窗口:±5 分钟
  • Nonce 防重放:同一 Nonce 5 分钟内不可重复使用
  • IP 白名单:如已配置,仅允许白名单内 IP 访问
  • 限流:按应用配置的 QPS 上限进行限流

通用说明

统一响应格式

Response
{
  "code": 0,
  "msg": "success",
  "data": { ... }
}

code = 0 表示成功,非 0 表示失败。分页接口返回 data.listdata.total

分页参数

参数类型必填说明
pageNoInteger页码,默认 1
pageSizeInteger每页条数,默认 10

权限类型

类型说明
READ只读权限
WRITE读写权限
FULL完全权限(含删除)

用户标识

  • externalUserId — 您的 App 中的用户唯一标识
  • appUserId — 商起点平台内部用户 ID(兼容旧版,建议使用 externalUserId)

商户数据

权限模块:merchant · 13 个接口

5.1 查询商户列表

GET/open-api/v1/merchants
参数类型必填说明
pageNoInteger页码
pageSizeInteger每页条数
merchantIdLong指定商户ID

权限:merchant:read

5.2 查询商户详情

GET/open-api/v1/merchants/{merchantId}

权限:merchant:read

5.3 查询门店列表

GET/open-api/v1/stores
参数类型必填说明
pageNoInteger页码
pageSizeInteger每页条数
merchantIdLong商户ID

权限:merchant:read

5.4 查询门店详情

GET/open-api/v1/stores/{storeId}

权限:merchant:read

5.5 查询附近门店

GET/open-api/v1/stores/nearby
参数类型必填说明
longitudeDouble经度
latitudeDouble纬度
radiusInteger搜索半径(米)

权限:merchant:read

5.6 查询门店营业时间

GET/open-api/v1/stores/{storeId}/business-hours

权限:merchant:read

5.7 商户注册(入驻)

POST/open-api/v1/merchants/register

权限:merchant:write

5.8 提交商户认证

POST/open-api/v1/merchants/{merchantId}/certification

权限:merchant:write

5.9 查询认证状态

GET/open-api/v1/merchants/{merchantId}/certification/status

权限:merchant:read

5.10 更新商户信息

PUT/open-api/v1/merchants/{merchantId}

权限:merchant:write

5.11 创建门店

POST/open-api/v1/stores

权限:merchant:write

5.12 更新门店

PUT/open-api/v1/stores/{storeId}

权限:merchant:write

5.13 删除门店

DELETE/open-api/v1/stores/{storeId}

权限:merchant:write

商品数据

权限模块:product · 15 个接口

6.1 查询商品列表

GET/open-api/v1/products
参数类型必填说明
pageNoInteger页码
pageSizeInteger每页条数
merchantIdLong商户ID
categoryIdLong分类ID
statusInteger状态(0=上架, 1=下架)

权限:product:read

6.2 查询商品详情

GET/open-api/v1/products/{productId}

权限:product:read

6.3 搜索商品

GET/open-api/v1/products/search
参数类型必填说明
keywordString搜索关键词
merchantIdLong商户ID
categoryIdLong分类ID
minPriceInteger最低价格(分)
maxPriceInteger最高价格(分)
sortFieldString排序字段
sortOrderString排序方向(asc/desc)

权限:product:read

6.4 查询商品分类列表

GET/open-api/v1/product-categories

权限:product:read

6.5 创建商品

POST/open-api/v1/products

权限:product:write

6.6 更新商品

PUT/open-api/v1/products/{productId}

权限:product:write

6.7 删除商品

DELETE/open-api/v1/products/{productId}

权限:product:full

6.8 商品上架/下架

PUT/open-api/v1/products/{productId}/status
请求体
{ "status": 0 }  // 0=上架, 1=下架

权限:product:write

6.9 创建商品分类

POST/open-api/v1/product-categories

权限:product:write

6.10 更新商品分类

PUT/open-api/v1/product-categories/{categoryId}?merchantId={merchantId}

权限:product:write

6.11 删除商品分类

DELETE/open-api/v1/product-categories/{categoryId}?merchantId={merchantId}

权限:product:full

6.12 库存入库

POST/open-api/v1/products/{productId}/stock-in

权限:product:write

6.13 库存出库

POST/open-api/v1/products/{productId}/stock-out

权限:product:write

6.14 查询库存变动日志

GET/open-api/v1/products/{productId}/stock-logs

权限:product:read

6.15 查询商品统计

GET/open-api/v1/products/statistics?merchantId={merchantId}

权限:product:read

订单数据

权限模块:order · 15 个接口

7.1 查询订单列表

GET/open-api/v1/orders
参数类型必填说明
pageNoInteger页码
pageSizeInteger每页条数
merchantIdLong商户ID
externalUserIdString用户标识
statusInteger订单状态

权限:order:read

7.2 查询订单详情

GET/open-api/v1/orders/{orderId}?merchantId={merchantId}

权限:order:read

7.3 查询订单状态变更历史

GET/open-api/v1/orders/{orderId}/status-history?merchantId={merchantId}

权限:order:read

7.4 查询订单统计

GET/open-api/v1/orders/statistics?merchantId={merchantId}

权限:order:read

7.5 查询退款详情

GET/open-api/v1/orders/{orderId}/refund?merchantId={merchantId}

权限:order:read

7.6 创建订单

POST/open-api/v1/orders
请求体示例
{
  "merchantId": 1,
  "storeId": 1,
  "externalUserId": "user_10001",
  "orderType": 1,
  "couponId": null,
  "voucherIds": [],
  "remark": "备注",
  "items": [
    { "productId": 1, "quantity": 2, "price": 1000 }
  ]
}

权限:order:write

7.7 取消订单

POST/open-api/v1/orders/{orderId}/cancel?merchantId={merchantId}

权限:order:write

7.8 确认收货

POST/open-api/v1/orders/{orderId}/confirm-receipt?merchantId={merchantId}

权限:order:write

7.9 核销订单

POST/open-api/v1/orders/{orderId}/write-off?merchantId={merchantId}

权限:order:write

7.10 申请退款

POST/open-api/v1/orders/{orderId}/refund?merchantId={merchantId}
请求体
{
  "refundAmount": 1000,
  "reason": "退款原因"
}

权限:order:write

7.11 订单评价

POST/open-api/v1/orders/{orderId}/review?merchantId={merchantId}
请求体
{
  "content": "评价内容",
  "rating": 5
}

权限:order:write

7.12 订单支付

POST/open-api/v1/orders/{orderId}/pay?merchantId={merchantId}
请求体
{
  "channelCode": "wx_pub",
  "userIp": "127.0.0.1",
  "returnUrl": "https://your-app.com/return",
  "channelExtras": {}
}

权限:order:write

7.13 更新配送状态

PUT/open-api/v1/orders/{orderId}/delivery-status?merchantId={merchantId}
请求体
{
  "deliveryStatus": 1,
  "deliveryNo": "SF1234567890"
}

权限:order:write

7.14 确认预约订单

POST/open-api/v1/orders/{orderId}/confirm-booking?merchantId={merchantId}

权限:order:write

7.15 变更预约订单

POST/open-api/v1/orders/{orderId}/change-booking?merchantId={merchantId}

权限:order:write

会员卡数据

权限模块:member_card · 14 个接口

8.1 查询会员卡模板列表

GET/open-api/v1/card-templates
参数类型必填说明
pageNoInteger页码
pageSizeInteger每页条数
merchantIdLong商户ID

权限:member_card:read

8.2 查询会员卡模板详情

GET/open-api/v1/card-templates/{templateId}

权限:member_card:read

8.3 创建会员卡购买单

POST/open-api/v1/member-card-purchases
请求体
{
  "merchantId": 1,
  "templateId": 1,
  "externalUserId": "user_10001",
  "phone": "13800138000",
  "paymentMode": 0
}

说明:paymentMode = 0(全款购卡)时,如用户未进件,可通过 phone 自动注册。

权限:member_card:write

8.4 创建会员卡购买收银台

POST/open-api/v1/member-card-purchases/{purchaseId}/cashier
请求体
{
  "returnUrl": "https://your-app.com/return",
  "expireMinutes": 30
}

权限:member_card:write

8.5 查询会员卡购买单

GET/open-api/v1/member-card-purchases/{purchaseId}

权限:member_card:read

8.6 查询会员卡列表

GET/open-api/v1/member-cards
参数类型必填说明
pageNoInteger页码
pageSizeInteger每页条数
merchantIdLong商户ID

权限:member_card:read

8.7 查询会员卡详情

GET/open-api/v1/member-cards/{cardNo}

权限:member_card:read

8.8 会员卡充值

POST/open-api/v1/member-cards/{cardNo}/recharge
请求体
{
  "amount": 10000,
  "tierId": 1
}

权限:member_card:write

8.9 生成会员卡核销二维码

POST/open-api/v1/member-cards/{cardNo}/write-off-qrcode

返回:核销二维码信息(含 qrCodeUrl、requestNo)

权限:member_card:write

8.10 查询会员卡核销记录

GET/open-api/v1/member-cards/write-off-records/{requestNo}

权限:member_card:read

8.11 确认会员卡核销

POST/open-api/v1/member-cards/write-off-records/{requestNo}/confirm
请求体
{
  "approved": true,
  "remark": "确认核销"
}

权限:member_card:write

8.12 查询会员卡消费记录

GET/open-api/v1/member-cards/{cardNo}/consumption-records

权限:member_card:read

8.13 查询会员卡统计

GET/open-api/v1/member-cards/statistics?merchantId={merchantId}

权限:member_card:read

8.14 申请会员卡退款

POST/open-api/v1/member-cards/refund/apply
请求体
{
  "cardNo": "MC20240001",
  "externalUserId": "user_10001",
  "refundAmount": 5000,
  "refundReason": "退款原因",
  "evidenceUrls": ["https://..."]
}

权限:member_card:write

优惠券

权限模块:coupon · 21 个接口

9.1 查询优惠券列表

GET/open-api/v1/coupons
参数类型必填说明
pageNoInteger页码
pageSizeInteger每页条数
merchantIdLong商户ID

权限:coupon:read

9.2 查询优惠券详情

GET/open-api/v1/coupons/{couponId}?merchantId={merchantId}

权限:coupon:read

9.3 查询用户优惠券

GET/open-api/v1/coupons/user
参数类型必填说明
externalUserIdStringApp端用户标识
merchantIdLong商户ID
pageNoInteger页码
pageSizeInteger每页条数

权限:coupon:read

9.4 查询优惠券模板列表

GET/open-api/v1/coupon-templates

权限:coupon:read

9.5 查询可领取优惠券

GET/open-api/v1/coupons/available?merchantId={merchantId}

权限:coupon:read

9.6 创建优惠券购买单

POST/open-api/v1/coupon-purchases
请求体
{
  "merchantId": 1,
  "templateId": 1,
  "externalUserId": "user_10001",
  "bizNo": "BIZ001",
  "storeId": 1
}

权限:coupon:write

9.7 创建优惠券购买收银台

POST/open-api/v1/coupon-purchases/{purchaseId}/cashier
请求体
{
  "returnUrl": "https://your-app.com/return",
  "expireMinutes": 30
}

权限:coupon:write

9.8 查询优惠券购买单

GET/open-api/v1/coupon-purchases/{purchaseId}

权限:coupon:read

9.9 领取优惠券

POST/open-api/v1/coupons/claim
请求体
{
  "merchantId": 1,
  "templateId": 1,
  "externalUserId": "user_10001",
  "storeId": 1
}

权限:coupon:write

9.10 购买优惠券

POST/open-api/v1/coupons/purchase

权限:coupon:write

9.11 验证优惠券

POST/open-api/v1/coupons/{couponId}/verify?merchantId={merchantId}

权限:coupon:read

9.12 核销优惠券

POST/open-api/v1/coupons/{couponId}/write-off
请求体
{
  "merchantId": 1,
  "storeId": 1,
  "remark": "核销备注"
}

权限:coupon:write

9.13 退款优惠券购买单

POST/open-api/v1/coupon-purchases/refund

权限:coupon:write

9.14 生成优惠券核销二维码

POST/open-api/v1/coupons/{couponId}/write-off-qrcode?merchantId={merchantId}

权限:coupon:write

9.15 查询优惠券核销记录

GET/open-api/v1/coupons/write-off-records/{requestNo}

权限:coupon:read

9.16 创建优惠券模板

POST/open-api/v1/coupon-templates

权限:coupon:write

9.17 更新优惠券模板

PUT/open-api/v1/coupon-templates/{templateId}?merchantId={merchantId}

权限:coupon:write

9.18 发布优惠券模板

PUT/open-api/v1/coupon-templates/{templateId}/publish?merchantId={merchantId}

权限:coupon:write

9.19 暂停优惠券模板

PUT/open-api/v1/coupon-templates/{templateId}/pause?merchantId={merchantId}

权限:coupon:write

9.20 恢复优惠券模板

PUT/open-api/v1/coupon-templates/{templateId}/resume?merchantId={merchantId}

权限:coupon:write

9.21 批量发放优惠券

POST/open-api/v1/coupon-templates/{templateId}/issue
请求体
{
  "merchantId": 1,
  "externalUserIds": ["user_001", "user_002"]
}

权限:coupon:write

抵金券

权限模块:cash_voucher · 9 个接口

10.1 购买抵金券

POST/open-api/v1/cash-voucher/acquire

权限:cash_voucher:write

10.2 创建抵金券购买收银台

POST/open-api/v1/cash-voucher/purchases/{purchaseId}/cashier

权限:cash_voucher:write

10.3 查询抵金券购买单

GET/open-api/v1/cash-voucher/purchases/{purchaseId}

权限:cash_voucher:read

10.4 查询抵金券购买折扣配置

GET/open-api/v1/cash-voucher/purchase-discount-config

权限:cash_voucher:read

10.5 退款抵金券

POST/open-api/v1/cash-voucher/refund

权限:cash_voucher:write

10.6 生成抵金券核销二维码

POST/open-api/v1/cash-voucher/{voucherId}/write-off-qrcode

权限:cash_voucher:write

10.7 赠送抵金券

POST/open-api/v1/cash-voucher/gift

权限:cash_voucher:write

10.8 撤销赠送

POST/open-api/v1/cash-voucher/revoke-gift

权限:cash_voucher:write

10.9 查询抵金券核销记录

GET/open-api/v1/cash-voucher/write-off-records/{requestNo}

权限:cash_voucher:read

客户管理

权限模块:customer · 9 个接口

11.1 客户进件建档

POST/open-api/v1/customers/intake
请求体
{
  "externalUserId": "user_10001",
  "realName": "张三",
  "phone": "13800138000",
  "idCardNumber": "110101199001011234",
  "nickname": "小张",
  "avatarUrl": "https://..."
}

说明:客户进件是使用会员卡、优惠券等交易功能的前提。

权限:customer:write

11.2 查询客户列表

GET/open-api/v1/customers
参数类型必填说明
merchantIdLong商户ID
pageNoInteger页码
pageSizeInteger每页条数

权限:customer:read

11.3 查询客户详情

GET/open-api/v1/customers/{customerId}?merchantId={merchantId}

权限:customer:read

11.4 按手机号换取平台用户ID

GET/open-api/v1/customers/platform-user-id-by-phone?phone={phone}

权限:customer:read

11.5 查询客户消费记录

GET/open-api/v1/customers/{customerId}/transactions?merchantId={merchantId}

权限:customer:read

11.6 查询客户标签

GET/open-api/v1/customers/{customerId}/tags?merchantId={merchantId}

权限:customer:read

11.7 添加客户标签

POST/open-api/v1/customers/{customerId}/tags?merchantId={merchantId}

权限:customer:write

11.8 移除客户标签

DELETE/open-api/v1/customers/{customerId}/tags/{tagName}?merchantId={merchantId}

权限:customer:write

11.9 查询客户统计

GET/open-api/v1/customers/statistics?merchantId={merchantId}

权限:customer:read

可预订资源

权限模块:resource · 11 个接口

12.1 查询资源列表

GET/open-api/v1/resources
参数类型必填说明
merchantIdLong商户ID
pageNoInteger页码
pageSizeInteger每页条数

权限:resource:read

12.2 查询资源详情

GET/open-api/v1/resources/{resourceId}?merchantId={merchantId}

权限:resource:read

12.3 查询资源可用性

GET/open-api/v1/resources/{resourceId}/availability?merchantId={merchantId}&date={yyyy-MM-dd}

权限:resource:read

12.4 批量查询资源状态

GET/open-api/v1/resources/batch-status?resourceIds={ids}&merchantId={merchantId}

权限:resource:read

12.5 查询资源统计

GET/open-api/v1/resources/statistics?merchantId={merchantId}

权限:resource:read

12.6 创建资源

POST/open-api/v1/resources

权限:resource:write

12.7 更新资源

PUT/open-api/v1/resources/{resourceId}?merchantId={merchantId}

权限:resource:write

12.8 删除资源

DELETE/open-api/v1/resources/{resourceId}?merchantId={merchantId}

权限:resource:full

12.9 更新资源状态

PUT/open-api/v1/resources/{resourceId}/status?merchantId={merchantId}

权限:resource:write

12.10 设置资源价格

PUT/open-api/v1/resources/{resourceId}/price?merchantId={merchantId}

权限:resource:write

12.11 设置资源排班

PUT/open-api/v1/resources/{resourceId}/schedule?merchantId={merchantId}

权限:resource:write

预约数据

权限模块:booking · 10 个接口

13.1 查询可用预约时间段

GET/open-api/v1/booking/available-slots
参数类型必填说明
merchantIdLong商户ID
resourceIdLong资源ID
dateString日期(yyyy-MM-dd)

权限:booking:read

13.2 查询预约列表

GET/open-api/v1/booking/orders

权限:booking:read

13.3 查询预约详情

GET/open-api/v1/booking/orders/{orderId}?merchantId={merchantId}

权限:booking:read

13.4 查询预约统计

GET/open-api/v1/booking/statistics?merchantId={merchantId}

权限:booking:read

13.5 创建预约订单

POST/open-api/v1/booking/orders

权限:booking:write

13.6 变更预约

PUT/open-api/v1/booking/orders/{orderId}?merchantId={merchantId}

权限:booking:write

13.7 取消预约

POST/open-api/v1/booking/orders/{orderId}/cancel?merchantId={merchantId}

权限:booking:write

13.8 确认预约

POST/open-api/v1/booking/orders/{orderId}/confirm?merchantId={merchantId}

权限:booking:write

13.9 开始服务

POST/open-api/v1/booking/orders/{orderId}/start?merchantId={merchantId}

权限:booking:write

13.10 完成服务

POST/open-api/v1/booking/orders/{orderId}/complete?merchantId={merchantId}

权限:booking:write

支付(收银台)

权限模块:payment · 2 个接口

14.1 创建收银台会话

POST/open-api/v1/payment/cashier/create
请求体
{
  "merchantId": 1,
  "outTradeNo": "YOUR_ORDER_NO_001",
  "subject": "商品购买",
  "body": "商品描述",
  "totalAmount": 10000,
  "expireMinutes": 30,
  "returnUrl": "https://your-app.com/return",
  "attach": "自定义附加数据"
}
响应示例
{
  "code": 0,
  "data": {
    "tradeNo": "123456789",
    "cashierUrl": "https://cashier.example.com/pay?token=xxx"
  }
}

说明

  • totalAmount 单位为分
  • outTradeNo 为您系统中的订单号,需保证唯一
  • 用户访问 cashierUrl 完成支付
  • 支付结果通过事件回调通知

权限:payment:write

14.2 查询支付结果

GET/open-api/v1/payment/query?tradeNo={tradeNo}
响应示例
{
  "code": 0,
  "data": {
    "tradeNo": "123456789",
    "outTradeNo": "YOUR_ORDER_NO_001",
    "tradeStatus": "SUCCESS",
    "totalAmount": 10000,
    "payTime": "2026-04-16T10:30:00",
    "attach": "自定义附加数据"
  }
}
交易状态说明
WAIT_BUYER_PAY待支付
SUCCESS支付成功
REFUND已退款
CLOSED已关闭

权限:payment:read

提现

权限模块:withdraw · 5 个接口

15.1 绑定提现账户

POST/open-api/withdraw/account/bind
请求体
{
  "externalUserId": "user_10001",
  "accountType": 1,
  "accountName": "张三",
  "cardNo": "6222021234567890",
  "bankName": "中国工商银行",
  "bankBranch": "北京朝阳支行"
}

权限:withdraw:write

15.2 解绑提现账户

DELETE/open-api/withdraw/account/unbind?accountId={accountId}

权限:withdraw:write

15.3 查询用户提现账户列表

GET/open-api/withdraw/account/list?externalUserId={externalUserId}

权限:withdraw:read

15.4 创建提现

POST/open-api/withdraw/create

权限:withdraw:write

15.5 查询提现状态

GET/open-api/withdraw/get?merchantWithdrawNo={merchantWithdrawNo}

权限:withdraw:read

B2B转账

权限模块:transfer · 2 个接口

16.1 创建B2B转账

POST/open-api/v1/transfer/b2b

说明:开发者将分账资金转到 App 用户的账户

权限:transfer:write

16.2 查询B2B转账状态

GET/open-api/v1/transfer/b2b?merchantTransferNo={merchantTransferNo}

权限:transfer:read

固定收款码

3 个接口

17.1 创建固定收款码

POST/open-api/fixed-qrcode/create
请求体
{
  "merchantId": 1,
  "storeId": 1,
  "subject": "门店收款",
  "defaultAmount": 0
}

17.2 删除固定收款码

DELETE/open-api/fixed-qrcode/delete?id={id}&merchantId={merchantId}

17.3 查询固定收款码列表

GET/open-api/fixed-qrcode/list?merchantId={merchantId}

数据统计

权限模块:statistics · 7 个接口

18.1 查询经营概览

GET/open-api/v1/statistics/overview?merchantId={merchantId}

权限:statistics:read

18.2 查询销售报表

GET/open-api/v1/statistics/sales
参数类型必填说明
merchantIdLong商户ID
startDateString开始日期
endDateString结束日期
granularityString粒度(day/week/month)

权限:statistics:read

18.3 查询客户分析

GET/open-api/v1/statistics/customers?merchantId={merchantId}

权限:statistics:read

18.4 查询渠道分析

GET/open-api/v1/statistics/channels?merchantId={merchantId}

权限:statistics:read

18.5 查询预约分析

GET/open-api/v1/statistics/bookings?merchantId={merchantId}

权限:statistics:read

18.6 创建报表导出任务

POST/open-api/v1/statistics/export

权限:statistics:read

18.7 查询导出任务状态

GET/open-api/v1/statistics/export/{taskId}?merchantId={merchantId}

权限:statistics:read

实名认证

权限模块:real_name_auth · 4 个接口

19.1 提交身份证 OCR 识别

POST/open-api/v1/real-name-auth/submit-id-card
请求体
{
  "idCardFrontUrl": "https://oss.example.com/front.jpg",
  "idCardBackUrl": "https://oss.example.com/back.jpg"
}

权限:real_name_auth:write

19.2 获取人脸核身 SDK 参数

GET/open-api/v1/real-name-auth/face-auth-params?idCardNumber={idCardNumber}

权限:real_name_auth:write

19.3 查询人脸核身结果

GET/open-api/v1/real-name-auth/face-auth-result?orderNo={orderNo}

权限:real_name_auth:read

19.4 查询认证状态

GET/open-api/v1/real-name-auth/status?idCardNumber={idCardNumber}

权限:real_name_auth:read

支付宝授权绑定

权限模块:alipay_auth · 4 个接口

20.1 获取支付宝授权配置

GET/open-api/alipay-auth/config

返回:支付宝 AppId 等配置信息

权限:alipay_auth:read

20.2 通过授权码绑定支付宝账号

POST/open-api/alipay-auth/bind
请求体
{
  "externalUserId": "user_10001",
  "authCode": "支付宝授权码"
}

权限:alipay_auth:write

20.3 查询用户支付宝绑定状态

GET/open-api/alipay-auth/binding?externalUserId={externalUserId}

权限:alipay_auth:read

20.4 解绑支付宝账号

POST/open-api/alipay-auth/unbind
请求体
{
  "externalUserId": "user_10001"
}

权限:alipay_auth:write

风控模型

权限模块:risk · 2 个接口

21.1 获取可调用的风控模型产品列表

GET/open-api/v1/risk-model-products

权限:risk:read

21.2 执行风控模型产品

POST/open-api/v1/risk-model-products/{productId}/execute
请求体
{
  "merchantId": 1,
  "externalUserId": "user_10001",
  "creditAmount": 10000,
  "input": {},
  "timeout": 5000
}

权限:risk:write

错误码

通用错误码

HTTP 状态码说明
401认证失败(AppKey无效 / 签名错误 / 时间戳过期 / Nonce重复)
403权限不足(应用已禁用 / IP不在白名单)
429请求频率超限

业务错误码

code说明
0成功
非0失败,具体错误信息见 msg 字段

常见业务错误:用户不存在、商户合作关系不存在、资源不存在、余额不足、订单状态不允许当前操作