API 接入文档

准备工作

欢迎接入侠客支付接口。本页仅提供接入概览,便于快速对接;完整参数与联调请登录商家中心查看。

在接入之前,请先确认是否完成以下步骤:
# 必要前提 说明
1 完成商家入驻并审核通过 注册账号后提交资料,审核通过后方可使用开放接口。立即注册
2 获取 API Key / Secret 登录商家中心 →「独立 API」查看 api_key 与 api_secret。进入商家中心
3 准备业务回调地址 准备可公网访问的 notify_url,用于接收支付成功通知(HTTPS 推荐)。
说明:接口仅对已审核商家开放,请勿将密钥写入前端页面或公开仓库。
快速接入

常用能力概览(金额单位为分)。独立 API 分两类:普通支付(商家中心收款码,直连 / 聚合)与卡密支付。

能力 方法 路径 说明
获取收款码 GET /api/merchant/open/qrcode 返回直连 / 聚合收款码。不传 pay_mode 时用资料页默认(默认直连)
创建支付 POST /api/merchant/open/pay 生成商家中心收款码页(pay.html 直连 / sft.html 聚合)
查询凭证 / 订单 GET /api/merchant/open/ticket/:code
/api/merchant/open/order/:trade_no
按凭证号或平台订单号查询
卡密查询 / 核销 GET / POST /api/card/open/query、/api/card/redeem 充值链接页售出的卡密,归属本商家才可核销

鉴权方式(简要)

  • 请求头携带:X-Api-Key: <api_key>
  • 可选签名:X-Timestamp + X-Sign(HMAC-SHA256,内容为 api_key + timestamp)

创建支付示例字段

{
  "amount": 10000,
  "pay_mode": "direct",
  "subject": "商品订单",
  "notify_url": "https://your.domain/notify",
  "extra": { "out_order_no": "YOUR_ORDER_NO" }
}

pay_mode:direct(直连)/ agg(聚合)。不传则使用商家中心「资料与审核」里的默认值。

异步通知

支付成功后,系统会向你提交的 notify_url 推送 JSON。请在业务侧验签并处理幂等,避免重复入账。

  • 主要字段:trade_no、amount、status、channel_code、paid_at、ticket、out_order_no、sign
  • 验签:按字段排序拼接后,使用 api_secret 做 HMAC-SHA256
  • 建议同时以「查询订单」接口做最终状态确认
注意事项
  • 本页为接入指引,不做全部接口与字段穷举公开。
  • 正式联调请在商家中心获取密钥,并在测试环境验证回调可达。
  • 如需技术支持,请通过「联系我们」留言或联系客服。
前往商家中心获取密钥 联系我们