Skip to content

代收 Open API 文档

本服务只承载代收商户开放接口说明,不包含其它业务线接口文档。

重要提示:发起代收下单时,可能因产品配置的匹配浮动范围影响,出现未匹配到当前下单金额支付页面链接的情况。平台可能提供其它金额的支付页面链接供用户付款,因此最终付款金额、查单结果或异步通知金额可能与商户下单金额不一致,商户给用户展示的付款金额及后续入账金额请以平台返回的 payableAmount 和异步通知金额为准!

接入流程

  1. 获取商户号 mchNo、商户密钥,并在商户后台-API管理-代收通道页面查询获取代收产品编码 channelCode,同时配置 API 请求 IP 白名单。
  2. 按签名规则生成 sign,调用 /api/v1/collection/order 创建代收订单。
  3. 根据下单响应中的 payableAmountpayDataTypepayData 引导用户打开支付页面完成付款。
  4. 通过 /api/v1/collection/query 主动查单,并按异步通知契约处理订单终态;查单只使用 mchOrderNo 作为订单定位字段。
  5. 如需查询代收账户资金,调用 /api/v1/collection/balance 获取可用余额和冻结余额。

接口清单

接口请求方式路径
代收下单POST/api/v1/collection/order
代收查单POST/api/v1/collection/query
代收余额查询POST/api/v1/collection/balance

文档入口

代收 Open API 文档