开发者接入指南

完善的API文档、多语言SDK和详尽的示例代码,助你快速完成支付功能集成

快速接入

简单四步,即可完成支付能力接入

1

注册账号

在生活圈支付官网注册商户账号,完成实名认证

2

创建应用

在商户后台创建应用,获取AppID和API密钥

3

下载SDK

根据开发语言选择对应SDK,参照文档完成集成

4

上线运行

配置回调地址,完成测试后即可正式接入生产环境

SDK 下载

提供多种开发语言的SDK,降低接入门槛

💻

Java SDK

适用于服务端Java应用,支持Spring Boot快速集成

JDK 8+ v2.4.1
下载 SDK
🐍

Python SDK

适用于Python服务端应用,支持Django/Flask框架

Python 3.7+ v1.8.3
下载 SDK
🔥

PHP SDK

适用于PHP服务端应用,支持Composer一键安装

PHP 7.4+ v3.2.0
下载 SDK

Node.js SDK

适用于Node.js服务端应用,支持Express/Koa框架

Node 14+ v2.1.5
下载 SDK
📱

iOS SDK

适用于iOS原生应用,支持Swift和Objective-C

iOS 12+ v4.0.2
下载 SDK
🤖

Android SDK

适用于Android原生应用,支持Kotlin和Java

API 24+ v4.0.2
下载 SDK

核心 API 接口

RESTful API 设计,统一响应格式,支持 HTTPS 加密传输

POST

创建支付订单

创建一笔新的支付订单,返回支付参数供客户端调起支付

/v1/pay/order/create
GET

查询订单状态

根据商户订单号或平台订单号查询订单支付状态

/v1/pay/order/query
POST

申请退款

对已支付成功的订单发起全额或部分退款

/v1/pay/refund/apply
POST

企业付款

向用户微信零钱或银行卡发起单笔或批量付款

/v1/pay/transfer
PUT

订单分账

对指定订单执行分账操作,将资金分账给多个接收方

/v1/pay/profitsharing
POST

预授权冻结

对信用卡额度进行冻结,适用于押金、保证金场景

/v1/pay/preauth/freeze
// Java SDK 调用示例
ShqPayClient client = new ShqPayClient.Builder()
    .appId("your_app_id")
    .apiKey("your_api_key")
    .build();

PayOrderRequest request = new PayOrderRequest();
request.setOutTradeNo("ORDER_20240101_001");
request.setTotalAmount(new BigDecimal("99.99"));
request.setSubject("商品名称");
request.setChannel("wx");
request.setNotifyUrl("https://your-domain.com/notify");

PayOrderResponse response = client.execute(request);
if (response.isSuccess()) {
    System.out.println("支付参数: " + response.getPayParams());
}

多语言代码示例

提供Java、Python、PHP、Node.js等主流语言的完整调用示例

Python Python 3.7+
# 安装: pip install shqpay
from shqpay import ShqPayClient

client = ShqPayClient(
    app_id="your_app_id",
    api_key="your_api_key"
)

order = client.pay.create_order(
    out_trade_no="ORDER_001",
    total_amount=99.99,
    subject="商品名称",
    channel="wx",
    notify_url="https://your-domain.com/notify"
)
print(order.pay_params)
PHP PHP 7.4+
// 安装: composer require shqpay/sdk
require_once 'vendor/autoload.php';

use ShqPay\Client;

$client = new Client([
    'app_id'  => 'your_app_id',
    'api_key' => 'your_api_key'
]);

$result = $client->pay->createOrder([
    'out_trade_no' => 'ORDER_001',
    'total_amount' => 99.99,
    'subject'      => '商品名称',
    'channel'      => 'wx',
    'notify_url'   => 'https://your-domain.com/notify'
]);
Node.js Node 14+
// 安装: npm install shqpay
const { ShqPayClient } = require('shqpay');

const client = new ShqPayClient({
    appId: 'your_app_id',
    apiKey: 'your_api_key'
});

const order = await client.pay.createOrder({
    outTradeNo: 'ORDER_001',
    totalAmount: 99.99,
    subject: '商品名称',
    channel: 'wx',
    notifyUrl: 'https://your-domain.com/notify'
});
console.log(order.payParams);
Go Go 1.18+
// 安装: go get github.com/shqpay/sdk-go
import "github.com/shqpay/sdk-go"

client, _ := shqpay.NewClient("app_id", "api_key")

order, _ := client.Pay.CreateOrder(shqpay.OrderRequest{
    OutTradeNo: "ORDER_001",
    TotalAmount: 99.99,
    Subject: "商品名称",
    Channel: "wx",
    NotifyURL: "https://your-domain.com/notify",
})
fmt.Println(order.PayParams)

安全接入指南

保障支付数据安全,防范交易风险

🔒

HTTPS 强制加密

所有API接口仅支持HTTPS协议传输,确保数据在传输过程中加密,防止中间人攻击和数据窃取。

🔧

请求签名验证

每笔请求均需携带RSA-SHA256数字签名,服务端严格校验签名有效性,防止请求被篡改或伪造。

🛡

IP 白名单

支持配置服务器出口IP白名单,仅允许指定IP地址发起API调用,从源头阻断非法请求。

🔏

密钥安全管理

API密钥仅存储在服务端,禁止在客户端、前端代码或版本控制中暴露。支持定期轮换密钥。

🔄

回调防重放攻击

回调通知携带时间戳和随机数,商户端应校验时间窗口并做去重处理,防止重放攻击。

📋

敏感数据脱敏

银行卡号、身份证号等敏感信息在日志和接口返回中自动脱敏处理,符合PCI DSS安全标准。

常见问题

接入过程中常见问题的解答,覆盖密钥获取、支付渠道、回调处理、沙箱测试等

如何获取 API 密钥?

注册并完成实名认证后,登录商户后台,在「应用管理」中创建应用,系统将自动生成 AppID 和 API 密钥。请妥善保管密钥,不要在客户端暴露。如需重置密钥,可在后台重新生成,旧密钥将在5分钟后失效。

支持哪些支付渠道?

目前支持微信支付(JSAPI、Native、H5、小程序、APP)、支付宝(电脑网站、手机网站、APP、小程序)、银联云闪付、银联卡刷卡支付(磁条卡、芯片卡、闪付)、国外银行卡支付(Visa、MasterCard、JCB、AE)等多种渠道。一次对接即可覆盖所有主流支付方式。

回调通知失败怎么办?

请确保回调地址可公网访问且返回 HTTP 200 状态码。系统会在 24 小时内最多重试 8 次,重试间隔为1分钟、5分钟、15分钟、30分钟、1小时、2小时、4小时、8小时。同时建议配合主动查询接口使用,确保订单状态同步。

如何接入沙箱环境测试?

在商户后台开启沙箱模式后,使用沙箱 AppID 和沙箱密钥调用接口。沙箱环境模拟真实支付流程,不产生真实资金交易,适合开发和测试阶段使用。沙箱环境支持模拟支付成功、支付失败、退款等各种场景。

计费方式是怎样的?

不同支付渠道的计费方式不同,具体请联系商务经理获取详细报价。

支付接口响应慢怎么排查?

首先检查网络延迟,建议使用ping和traceroute测试到API服务器的网络质量。其次检查请求参数是否正确,错误的参数会导致额外的校验时间。最后查看是否开启了调试日志,生产环境建议关闭详细日志以提升性能。如持续缓慢请联系技术支持。

退款多久能到账?

退款申请提交后,系统实时处理。微信和支付宝退款一般即时到账,最迟不超过24小时。银联卡刷卡退款需经过银联清算,通常1-3个工作日到账。退款到账时间受银行处理速度影响,节假日可能顺延。

如何查询交易对账单?

可通过「交易对账单」API按日下载对账文件,格式为CSV。也可登录商户后台,在「交易管理-对账单」中在线查看和下载。对账单包含所有交易明细、手续费、结算金额等信息,方便与财务系统对账。

支持分账功能吗?

支持。平台型商户可使用「订单分账」接口,在支付完成后将资金按比例或固定金额分账给多个接收方。分账接收方需提前在后台配置。分账功能可有效规避二清风险,满足平台型业务的合规需求。

接入过程中遇到技术问题怎么办?

可通过以下渠道获取技术支持:1) 查看开发者文档和FAQ;2) 加入开发者QQ群(群号:800-xxx-xxxx)与社区交流;3) 提交工单至技术支持团队,工作日2小时内响应;4) 紧急问题可拨打7x24小时技术支持热线。

准备好开始接入了吗?

注册商户账号,获取 API 密钥,最快1小时完成支付功能上线

立即注册接入