Skip to content

开始集成

环境准备

在开始前,请您确保已完成 设置测试环境 步骤以便继续。 环境信息如下:

测试环境https://p-gate-uat.checus.com/aggregate-pay/api/gateway/<PATH>
正式环境https://pay-gate-hk-prod.checus.com/aggregate-pay/api/gateway/<PATH>

交互流程

关键接口

关联交互时序调用方向接口地址
创建支付,调用纯API下单商户 -> Checus/orderAndPay
支付结果异步通知Checus -> 商户/collectResultNotifyUrl
查询交易结果商户 -> Checus/orderQuery

集成步骤

1. 创建支付会话

调用 API支付/oderAndPay API ,发起POST请求以创建支付。

2. 跳转用户认证

若支付涉及额外认证(如卡支付 3DS、钱包登录等),/orderAndPay 接口响应中将返回 redirectUrl,且 data.status = PENDING

您应将用户重定向至该 URL,引导其完成认证流程。认证完成后,用户将返回您的页面或支付完成页。

3. 获取支付结果

方式1 . 支付结果通知

支付完成后,Checus 会通过回调向您发起 支付结果通知/collectResultNotifyUrl API 。可能多次重试,直到您返回成功响应。

回调地址配置方式:

  • 接口传入:通过 /orderAndPaynotifyUrl 参数传入,仅对当前订单生效;
  • 平台设置:在 商户管理平台 配置全局回调地址,适用于所有订单。

您在收到支付结果通知后,应返回处理结果。如果未响应或返回失败,Checus 将按以下间隔重试通知: 0s / 30s / 300s / 600s / 3600s / 43200s,最多重试 6 次。

方式2 . 主动查询支付结果

若未收到通知,或订单状态不明确,可主动调用 交易查询/orderQuery API 获取支付结果。

您应根据响应中的 code 判断查询是否成功,并通过 data.status 判断支付状态。请勿依据 code、msg 或 data.resultMsg 判断支付状态。

如遇报错,请参考 错误码列表 排查。

支付结果状态列表

状态说明
SUCCESS支付成功
PENDING等待支付中
FAILED支付失败
CLOSED超时未支付,交易关闭

基于 MIT 许可发布