Skip to content

API 参考

接口总览

#接口路径幂等键说明
1列卡头/api/v1/openapi/card_headers/list查看可申请的卡头列表
2列卡配置/api/v1/openapi/card_configs/list查看卡头下的套餐
3列出银行卡/api/v1/openapi/cards/list列出商户名下的卡(状态/日期/余额过滤)
4申请虚拟卡/api/v1/openapi/card/apply✅ 必填异步开卡
5首充预览/api/v1/openapi/card/first_deposit/preview试算首充手续费 / 冻结额
6创建充值/api/v1/openapi/card/recharge✅ 必填异步充值
7查询卡片信息/api/v1/openapi/card/info状态轮询
8Webhook 事件历史/api/v1/openapi/webhook_events/list排查 webhook 投递
9查询所有交易明细/api/v1/openapi/transactions/list名下所有卡的交易明细
10查询单卡交易明细/api/v1/openapi/card/transactions/list单张卡的交易明细
11冻结卡片/api/v1/openapi/card/freeze冻结一张活跃虚拟卡
12解冻卡片/api/v1/openapi/card/unfreeze解冻用户主动冻结的卡

通用约定

  • 方法:所有接口都是 POST
  • Content-Typeapplication/json(请求与响应均是)
  • 鉴权:每次请求 4 个签名头(详见 HMAC 鉴权
  • 国际化:通过 Accept-Language: zh-CN | en-US 切换 message 文案
  • 响应包络
json
{
  "code": 200,           // HTTP 状态码同步
  "message": "成功",
  "message_key": "...",  // 仅错误时返回
  "data": { ... }        // 业务数据
}

分页约定

所有 */list 接口(除 /card_configs/list)支持分页:

字段类型默认限制
pageint1≥ 1
page_sizeint20≤ 100

响应包含:

json
{
  "list": [...],
  "total": 12,
  "page": 1,
  "page_size": 20,
  "total_pages": 1,
  "has_next": false,
  "has_prev": false
}

采用 MIT 等价条款发布