跳转到主要内容

1.1 产品概览

本章介绍 GatePay 订阅支付产品的对接流程,帮助商户完成从产品创建、订阅计划配置、订单生成到扣款管理的完整闭环。

1.2 核心流程

订阅支付是 GatePay 提供的周期性扣款解决方案,适用于会员制、SaaS 服务等需要定期收款的场景。端到端流程分为五个阶段:
  1. 产品准备:创建和管理订阅产品及其价格信息
  2. 计划配置:配置扣款周期、试用期限、扣款次数等规则
  3. 订单创建:生成订阅订单并获取授权链接
  4. 用户授权:用户完成授权后进入扣款周期
  5. 周期扣款:系统自动按周期执行扣款

1.3 商户集成步骤

1.3.1 配置产品与计划

  • 商户需调用 POST /merchant/open/v1/pay/merchant/product/create 创建产品信息和价格 。准备就绪后,调用 POST /open/v1/plan/save 创建订阅计划并关联对应的价格编号 。

1.3.2 发起订阅订单

  • 当用户确认购买时,商户后端请求 POST /open/v1/order/create 创建订阅订单。接口将返回 subscriptionLink 订阅页面链接。

1.3.3 引导用户授权

  • 商户前端获取到 subscriptionLink 后,将用户重定向至该链接,引导用户发起订阅授权。

1.3.4 获取订阅状态

  • 授权与扣款状态主要依赖 GatePay 的异步消息通知获取。商户也可调用 GET /open/v1/order/detail 查询订阅详情作为兜底确认。

1.4 常见问题

Q:订阅订单的有效期是多久? A:订阅订单本身没有固定有效期,根据配置的 totalPayCount(扣款次数)或 endTime(结束时间)自动终止。未配置则视为长期订阅。 Q:如何设置试用期? A:创建订阅计划时通过 trialDays 参数设置试用天数。试用期内不会执行扣款,试用期结束后立即开始首次扣款。 Q:如何设置首期优惠? A:在创建产品价格时配置 promoConfigType:
  • FIX_AMOUNT:设置 promoAmount 为首期优惠金额
  • RATE:设置 promoRate 为首期折扣率(如1折存储为0.1)
Q:订阅开始后如何手动完成订阅? A:商户可调用 POST /open/v1/order/complete 接口,设置 operationType=FINISH 完成订阅,完成后不再执行后续扣款。

1.5 订单状态说明

状态说明
CREATED订阅订单创建成功,待用户授权
AUTHORIZED已授权,等待首次扣款
TRIAL试用期中,未发起扣款
RUNNING正常运行中,开始订阅计划
UNPAID待支付,试用结束或运行中扣款失败,未达到重试上限
COMPLETED已完成,达到扣款次数上限或结束日期或手动完成
CANCELLED已取消,商户主动取消订阅订单
CLOSED已关闭,扣款失败次数超限等异常情况
BLOCKED拦截,已扣款但用户资金有风险