1. 默认模块
Wayflow
  • 默认模块
    • 接入指南
    • 认证与签名
    • 加密与解密
    • Webhook 通知
    • 错误码与重试
    • 关于SDK
      • SDK 使用指南
      • PHP 快速开始
      • Java 快速开始
      • Node.js / TypeScript 快速开始
      • Python 快速开始
      • Go 快速开始
    • 卡产品组
      • 卡产品组列表(分页)
        POST
      • 卡产品组列表(非分页)
        POST
      • 卡产品组详情
        POST
    • 卡产品
      • 卡产品相关字典
        • 费用模型字典
        • 舍入模式字典
      • 卡产品列表(分页)
        POST
      • 卡产品列表(非分页)
        POST
      • 卡产品详情
        POST
    • 卡钱包
      • 卡钱包划转
        • 卡钱包转出
        • 卡钱包转入
      • 卡钱包相关字典
        • 交易订单状态字典
        • 交易订单流向字典
        • 交易订单审批状态字典
      • 卡钱包查询
        • 卡钱包列表(分页)
        • 卡钱包列表(非分页)
        • 卡钱包详情
    • 卡片交易
      • 交易查询
        • 卡片交易列表(分页)
        • 卡片交易列表(非分页)
        • 卡片交易详情
      • 卡片交易相关字典
        • 交易类型字典
        • 交易状态字典
        • 交易商户国家字典
        • 交易资金流向字典
    • 卡钱包交易
      • 卡钱包交易订单
        • 卡钱包转账订单列表(分页)
        • 卡钱包转账订单列表(非分页)
        • 卡钱包转账订单详情
        • 取消卡钱包转账订单
      • 卡钱包交易流水
        • 卡钱包流水列表(分页)
        • 卡钱包流水列表(非分页)
        • 卡钱包流水详情
    • 卡片
      • 卡片查询
        • 卡片列表(分页)
        • 卡片列表(非分页)
        • 卡片详情
        • 查询卡片敏感信息
      • 卡片发行
        • 发卡预检
        • 发卡
      • 卡片更新
        • 消费控制配置示例
        • 更新卡片消费规则
        • 更新卡片别名
      • 卡片状态操作
        • 卡片冻结
        • 卡片解冻
        • 卡片注销
      • 卡片任务
        • 发卡任务详情
        • 发卡任务明细(分页)
        • 批量修改卡片状态
        • 卡片状态任务明细(分页)
        • 卡片状态任务详情
      • 商户查询
        • 商户列表(分页)
        • 商户详情
      • 卡片相关字典
        • 卡片状态字典
        • 国家字典
        • 消费限制类型字典
        • 消费限额周期字典
        • 时区字典
  1. 默认模块

接入指南

Consumer API 接入指南#

本指南介绍从创建 API Key 到完成首次接口调用的接入流程。
接入顺序:创建 API Key → 保存密钥 → 配置接入程序 → 启用 API Key → 发起首次调用。

1. 创建 API Key#

1.
进入开发者中心,点击「创建 API Key」。
2.
填写名称、允许访问的 IP,选择接口权限。
3.
选择密钥方式,按下表完成设置。
4.
确认信息,完成安全验证。
方式操作及私钥来源
自动生成密钥平台生成密钥,创建成功后下载并妥善保存密钥文件。
手动上传公钥上传客户端鉴权公钥和客户端加密公钥,配对私钥由接入方自行保管。平台不提供这些私钥。

2. 配置接入程序#

生产环境 Base URL
https://api.lampay.app
联调环境使用平台分配的地址。
准备以下配置:
配置用途
Base URLAPI 调用地址
API Key调用凭证
客户端鉴权私钥生成请求签名
平台鉴权公钥验证响应签名
客户端加密私钥解密敏感响应和 Webhook
平台加密公钥加密请求
首次只读调用需要前四项;涉及加解密时,再配置相应密钥。私钥来源见上方创建方式。
平台公钥及所需指纹从开发者中心获取。
Webhook 另需配置接收方 API Key 业务 ID,不要与调用凭证或公钥指纹混用。两套客户端私钥分开保管,仅在服务端使用。
在运行示例的终端设置:
MERCHANT_* 是示例变量名,对应客户端私钥;示例通过文件路径读取 PEM 内容。
SDK 是平台提供的服务端开发工具,负责请求签名、响应验签,并提供加解密能力。获取指定版本的 SDK 源码交付包,按包内安装说明接入项目,并固定交付版本及依赖。
只需选择一种语言:
语言环境与示例
Node.js / TypeScriptNode.js 18+
PHPPHP 8.1+、Composer
JavaJava 17+、Maven
PythonPython 3.9+
GoGo 1.21+
完成所选语言的安装和配置后,按下一节启用 API Key,再运行示例。

3. 启用 API Key#

配置完成后,在开发者中心启用该 API Key。

4. 完成首次调用#

运行所选语言的示例,发起第一次只读调用:
{"page": 0, "size": 20}
成功条件:响应验签通过、HTTP 2xx、业务响应 success=true。SDK 通常直接返回业务 data;各语言示例注明了取值方式。
失败时保存 HTTP 状态、错误码及请求 ID,按错误码与重试排查。不要关闭验签,也不要记录私钥、完整凭证或敏感数据。

5. 接入业务#

操作关联步骤
查询产品与钱包产品组 ID 可从卡产品组列表获取
发卡建议先调用发卡预检;发卡使用加密请求及幂等键
查询发卡结果单张、多张均返回批次 ID,用于查询发卡任务详情及明细
接收通知登记 HTTPS 回调地址、接收方 API Key 和订阅事件类型
写操作的幂等键由业务系统生成并保存。同一业务重试复用原幂等键及相同业务内容,每次发送重新生成签名所需的时间戳和 nonce。
协议细节按需阅读:认证与签名 · 加密与解密 · Webhook 通知。
修改于 2026-09-18 14:22:11
下一页
认证与签名
Built with