DEVELOPER CENTER

无缝对接「Open API」
驱动业务快速增长

「Open API」将各类系统与碧麒麟的支付网络无缝衔接, 让企业轻松灵活开展线上线下支付交易。

深色办公室一角的双显示器与机械键盘,屏幕亮着蓝色的光
  1. 企业业务系统

    已有的商城、收银或会员系统,不用推倒重来。

  2. Open API

    一套统一接口层,线上线下走同一套规则。

  3. 碧麒麟支付网络

    接进来之后,线上线下都能收款与对账。

CAPABILITY

丰富的 API 产品能力,
支持定制化对接

浅灰台面上并排立着的手机、平板与小票打印机

基于碧麒麟搭建的线上线下收付款 SAAS 体系,「Open API」提供丰富产品能力的同时, 可根据企业实际需求定制专属集成方案,按企业自己的业务流程来配。

接口开在这套体系之上,能力按模块拆开取用,接进来之后仍然是同一本账、同一套对账口径。

  • 接在已有的收付款体系上

    线上线下收付款的 SAAS 体系已经跑在前面,接口开在这套体系之上,不用为接入再搭一份账。对账口径与结算主体都沿用原来那一套。原来的收银与记账流程不必推翻,接口调通之后,账目仍然汇进同一套账户里。

  • 能力按业务取用

    需要哪一段能力就接对应的部分,用不到的功能不必一起接进来。可以先接最急的那一段,跑顺了再补下一段。接一段、验收一段,再放下一个场景,节奏由企业自己排。

  • 定制化专属集成方案

    按企业实际业务流程设计对接方式,让接口去适配现有系统,而不是反过来。接口的范围与调用顺序,照现有流程排。哪一步需要人工确认、哪一步可以自动走完,先把流程讲清楚,再落到接口上。

WHO CONNECTS

三类系统,接的是同一套接口

接进来的不一定是自建研发团队:可能是已经有商城的,也可能是正在用收银机的,
或者是本身就在做 SaaS 平台的——切入位置不同,走的却是同一套接口。

门店收银台上立着的收银机、扫码枪、息屏的手机与一块空白立牌
  • 线上商城与小程序

    商城、H5 与小程序的下单和支付都在服务端完成,用户在前端看到的只是「付好了」。 退款与查询同样走接口,不用再回通道后台逐笔操作。

    下单 · 支付 · 退款 · 查询

  • 门店收银与硬件

    收银机、扫码枪、智能 POS 本来就在跑,接口把交易结果与对账数据回传到门店系统。 店员的收银习惯不用改,手上这套设备也不必换。

    收银 · 聚合码 · 智能 POS

  • 平台与 SaaS 服务商

    一次对接,把收款能力开给自己的商户。交易与结算按商户维度分开记, 平台侧只需要维护一份接口配置,不必为每家商户单独搭一套通道。

    开放平台 · 分账 · 结算

SUPPORT

专业技术团队指导,全流程高效安全对接

从读文档到正式上线,中间每一步都有人可以问。
文档、方案、测试三件事,分别由不同的人负责。

  • 浅木桌上摊开的一叠打印文档与一支签字笔

    文档

    文档清晰易懂

    「Open API」文档由具有丰富行业经验的开发者编撰,把各类业务场景整合在一起,参数拿不准时先查文档。每个场景都附了可以直接照着走的调用顺序,不必自己拼。

  • 白板上用马克笔画出的方框与箭头流程图

    沟通

    客户经理与行业专家一起谈需求

    专属客户经理与行业专家一同与企业沟通定制化需求,先把业务怎么跑讲清楚,再落到接口上。需求确认之后,会先落成一份对接清单再开工。

  • 俯拍的工作台,桌上放着笔电、两部手机、数据线与一杯咖啡

    测试

    沙盒里先跑一遍,再上生产

    提供沙盒测试环境,上线前配合完成全流程测试;测试阶段的请求与数据全程加密传输,不接触真实资金,跑通了再切生产参数。

INTEGRATION

集成化流程整合,打通完整管理链路

通过与碧麒麟进行「Open API」对接,实现材料上传、合规审核、资金交易等多个操作流程的一体化整合, 以更具合规性的业务与资金管理架构,满足企业高效运营需求。

  1. 材料上传

    商户与门店资料在系统内一次提交,不用在两套后台之间来回搬。

  2. 合规审核

    审核状态回传到业务系统,流程按状态自己往下走,不必盯着后台看。

  3. 资金交易

    交易、退款与结算走同一条链路,资金流向与业务单据能对得上。

  • 安全高效
  • 资质审核
  • 一体化整合

这条链路真正的价值不在「接了一个接口」,而在于资料、审核与资金三套记录不再各自为政:同一笔业务卡在哪个环节,系统里看得见,也能被系统自己接着往下走。

COVERAGE

接口能覆盖到交易的哪些环节

下表不是接口清单,只把一笔交易要经过的环节按顺序排开,方便判断系统要动哪一段。

「Open API」大致覆盖的业务环节
业务环节 通过接口能做的事 常见用在
支付下单 发起一笔线上或线下收款,返回支付结果与交易流水号 商城下单、扫码付款、收银台结账
回调通知 交易状态变化时主动通知业务系统,不用轮询等结果 自动发货、订单状态流转、到账提醒
退款 按原订单发起全额或部分退款,结果同样回到业务系统 售后退款、订单取消、差错处理
交易查询 按订单号或流水号查交易状态与发生时间 支付结果确认、掉单排查
资金对账 拉取每日交易明细与结算记录,与门店账面逐笔对应 日终结账、财务核对
分账 按约定规则把一笔收款拆给多个结算主体 连锁、加盟、平台型商户
会员账户 储值、积分与优惠券挂在会员名下,按会员维度记账 储值消费、积分核销、券包发放

上表按一笔交易的先后顺序排列,只作业务判断用;具体接口范围、字段与调用限制,以对接时双方确认的清单为准。

ONE REQUEST, FIVE STEPS

一次请求,走完五步才算落账

很多对接问题出在第三步:页面跳回来了,就当支付成功了。 真正作数的是第四步——通道主动推给商户的那一次通知。

  • 商户系统 商户自己实现的环节
  • 仅作展示 跳回来的一次,不作为依据
  • 以它为准 订单状态的最终依据
  1. 01

    发起下单

    商户系统把订单号、金额、商品说明传给通道,换回一个能用来付款的凭证。

    容易忽略 订单号要能唯一对上一笔单,重试时拿原号查结果,不要另开一笔。

    商户系统
  2. 02

    唤起支付

    用这个凭证调起微信或支付宝的付款界面,顾客确认金额并完成付款。

    容易忽略 金额以通道返回的为准,前端传多少都不构成对账依据。

    双方
  3. 03

    同步返回

    付完款回到商户页面,这一跳只用来展示结果,不能当成最终依据。

    容易忽略 用户关掉页面这一跳就丢了,不能靠它改订单状态。

    仅作展示
  4. 04

    异步通知

    通道把最终结果再推一次到商户的接收地址,验签通过后按它更新订单状态。

    容易忽略 同一笔通知可能来多次、也可能乱序,处理要能重复执行。

    以它为准
  5. 05

    对账落账

    按日拉取交易与结算明细,和自己的订单表逐笔核对,对不上的当天查明。

    容易忽略 以通道账单为准,差异拖到第二天就要翻记录了。

    商户系统

FLOW

「Open API」对接流程

五个阶段,前一阶段验收通过再进入下一阶段。测试全程不动真实资金, 正式上线前会一起把配置再核对一遍。

  1. API 对接准备

    确认要接的业务场景与接口范围,把商户资料和对接人定下来。

  2. 测试环境配置

    在沙盒环境拿到测试参数,把密钥与回调地址配到位。

  3. 测试环境联调

    把下单、支付、退款与回调跑通,确认签名和报文没有偏差。

  4. 上线验收

    切换到生产参数,用真实交易核对结果与账单。

  5. 正式上线

    进入日常运营,遇到异常时由对接的技术同学一起看。

FAQ

对接前最常问的六件事

没列到的直接问,电话和邮件都有人看。

邮件里带上商户号与订单号,能少一次来回。

我们没有自己的技术团队,能接吗?

接口对接需要研发同学配合。如果没有自己的研发团队,可以先用智掌柜的收银系统与智能硬件把收款跑起来; 确认要做定制对接时,客户经理与行业专家会先一起把业务流程讲清楚,再由技术团队全流程指导上线。

对接前需要准备什么?

三样东西:要接的业务场景与接口范围、商户与门店资料、一位对接人和回调地址。 这三样定下来,测试参数才发得出来。

沙盒环境和生产环境有什么差别?

沙盒用测试参数把下单、支付、退款与回调跑通,不动真实资金;验收阶段再换成生产参数, 用真实交易核对结果与账单。切换之前两边会一起确认一遍配置。

只接其中一部分能力可以吗?

可以。能力按业务取用,需要哪一段就接哪一段,用不到的不必一起接进来; 后面要加,再补对应的部分就行。

资料和交易数据怎么保证安全?

对接与传输全程加密,材料上传、合规审核、资金交易在同一条链路上完成, 审核状态与交易记录都留在系统里,事后可以回溯到单笔。

上线之后出问题找谁?

对接时确定的技术同学会继续跟。服务时间内可以直接打电话,也可以把商户号与订单号发到邮箱, 方便直接定位到那一笔交易。

需要接口文档与联调支持?

留下联系方式,我们把接口文档、示例代码和接入清单一起发给你。