跳转至

开放 API 概述

面向第三方系统(ERP / OMS 等)服务端对接,提供:

  • 创建收款单:生成可支付链接
  • 获取可用支付通道:按地区/金额列出通道,供人工指定
  • 查询订单:轮询支付状态
  • 支付结果回调(Webhook):订单支付成功/失败及物流相关事件的服务端通知
  • 可选浏览器回跳:客户支付完成后跳转回你的网站

Base URL

开放 API 与收银台部署同源。将下文中的 {BASE_URL} 替换为平台提供的收银台根地址(示例:https://pay.example.com)。

所有业务接口路径前缀为:

{BASE_URL}/api/v1/open

接口一览

方法 路径 说明
POST /api/v1/open/charges 创建收款单(可选 retry_of 做失败重试;可选 gateway_id 指定通道)
GET /api/v1/open/charges/{orderId} 查询订单
GET /api/v1/open/charges/{orderId}/retry-advice 查询这单是否需要换通道重试
GET /api/v1/open/payment-gateways 获取可用支付通道(可选 retry_of

鉴权方式见 鉴权。回调约定见 支付结果回调。支付失败后换通道再试见 失败后重新建单。人工指定通道见 获取可用支付通道