API Documentation 支付接入、接口契约与问题排查
SANDBOX CONTRACT 返回首页 登录 Dashboard
Developer integration surface

Build payments against a visible contract.

用真实 Dummy Order 与 HPP 验证 USD 支付跳转、买家结果和商户返回地址。页面明确区分当前可运行能力与尚未开放的生产架构。

PUBLIC ACCESS SANDBOX FIRST VERSION v1 AUTHENTICATED MERCHANT
Documentation map

从第一次请求到问题定位

01

Quickstart

创建真实 Sandbox 订单、打开 HPP,并把买家带回你提供的 HTTPS returnUrl。

AVAILABLE
02

API Reference

当前开放 Dummy Orders 与商户业务查询日志;两者都要求已登录的商户身份。

AVAILABLE
03

API Query Logs

通过 queryNo、productId、费用、状态与错误信息定位业务 API 查询结果。

AVAILABLE
Website integration · current sandbox

把真实 HPP 返回流程接到你的网站

01

准备你网站的 HTTPS 返回页

例如 https://merchant.example/checkout/result。HuizhiPay 会把这个地址原样保存为订单 returnUrl,买家完成 HPP 后可返回该页面。

02

从外部网站服务端创建 USD 测试订单

先签发并激活 hzp_test_...,再登记并验证该商户的返回 Origin。外部网站服务端调用 Test Payment API;不要把 Key 或登录 Cookie 发送到浏览器。

const response = await fetch('http://127.0.0.1:8080/api/v1/test/payments', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-HuizhiPay-Api-Key': process.env.HUIZHIPAY_TEST_API_KEY
  },
  body: JSON.stringify({
    merchantOrderNo: 'SHOP-20260916-001',
    amount: 10.00,
    currency: 'USD',
    productName: 'Test product',
    successRedirectUrl: 'https://merchant.example/checkout/result?state=success',
    failureRedirectUrl: 'https://merchant.example/checkout/result?state=failed'
  })
});
const { data: order } = await response.json();
03

把买家送到返回的 paymentUrl

打开订单响应中的 paymentUrl,买家在 HPP 选择 Sandbox 成功或失败。之后检查订单状态和 returnUrl 返回行为,确认你的网站能恢复自己的 checkout 上下文。

Published endpoints

当前真实接口

Endpoint用途认证关键结果
POST /api/v1/dummy/orders创建 USD Sandbox 订单商户 OWNER / ADMIN,会校验 KYBorderNo、checkoutToken、paymentUrl、returnUrl、status
GET /api/v1/dummy/orders?page=1查看当前商户测试订单已登录商户分页订单与真实状态
GET /api/v1/developer/api-keys查看当前商户最近 20 条 Test Key 摘要商户所有只读及以上角色keyPrefix、enabled、createdAt、disabledAt
POST /api/v1/developer/api-keys签发或轮换 hzp_test_... KeyAPPROVED 商户 OWNER / ADMIN明文 secretKey 仅返回一次
DELETE /api/v1/developer/api-keys/{keyId}停用当前商户的活动 Test Key商户 OWNER / ADMIN停用后立即拒绝鉴权
GET /api/v1/developer/query-logs查看当前商户最近 100 条业务 API 查询商户所有只读及以上角色queryNo、productId、costAmount、status、errorMessage、createdAt
Troubleshooting

用业务查询日志定位问题

登录后打开 /merchant/developer/logs。SUCCESS 表示业务查询完成,PROCESSING 表示仍在执行,FAIL 会同时展示错误摘要,REFUNDED 表示该次查询费用已退款。日志由服务端按当前商户隔离,不返回 queryParams 或第三方原始响应。