Skip to main content
API 集成适合需要完全控制支付流程的场景。你可以直接调用 Waffo REST API，并将用户支付、订阅、退款和 Webhook 处理逻辑接入到自己的系统中。

​
适用场景

  • 服务端到服务端的支付处理
  • 已有自建收银台或支付表单
  • 需要最大灵活性的定制化集成

​
接入路线图

1

选择产品方案

一次性支付适合单次收款订单；订阅支付适合周期扣款场景。
2

接入必需接口

一次性支付必接创建订单、查询订单和支付结果通知。订阅支付必接创建订阅、查询订阅、订阅状态通知和订阅支付通知。
3

按业务需要接入条件接口

只有业务流程需要时，再接入取消、退款、退款查询、退款通知、订阅管理页或订阅升降级。
4

使用 API Reference 查看字段细节

请求字段、响应字段、枚举和签名规则以 API Reference 为准，不要从离线 PDF 复制字段定义。
5

在沙盒测试

使用 沙盒与测试。如需 Apple Pay 或 Google Pay，请完成对应检查。
6

提交验收材料

首次集成时，按产品类型下载 一次性支付验收用例模板 或 订阅支付验收用例模板。仅在非首次的一次性支付额外集成时，下载 一次性支付额外集成验收用例模板。填写已执行用例，并提交给 Waffo 技术对接群。

​
Base URL

​
请求格式

  • Content-Type: application/json（UTF-8 编码）
  • 所有请求使用 HTTP POST
  • 需携带 X-API-KEY 和 X-SIGNATURE 请求头
  • 原始 HTTP 请求需显式携带 X-API-VERSION: 1.0.0。使用 SDK 时由 SDK 自动管理该请求头，请勿手动设置或覆盖。版本历史中的 v1.3 是 API 文档和外部合同的修订序列，不能作为该请求头的值
  • 每个 /api/v1/subscription/create 请求都必须传入 subscriptionManagementUrl

​
响应格式

  • code 为 "0" 表示成功
  • 失败时 code 为错误码（如 "A0003"），data 为空
  • 响应头 X-SIGNATURE 包含 Waffo 签名，必须验证

​
核心接口

​
一次性支付

​
订阅支付

​
配置查询

​
验收用例模板

完成 API 集成和沙盒测试后，根据集成阶段下载并填写对应模板：
当前模板适用于 ONE_TIME_PAYMENT。仅当你已经完成过至少一次集成验收，本次属于非首次的额外集成时，才使用额外集成验收用例模板。首次集成不要使用此模板。
填写完成后，将验收结果提交给 Waffo 技术对接群确认。上线前验收标准参见 集成验收标准。