跳到主要内容

认证

PayerScan API 使用 API Key 认证。每个商店拥有独立的 API Key，必须包含在每个请求中。

请求头​

所有 API 请求必须包含 x-api-key 头：

x-api-key: YOUR_API_KEY

请求示例​

curl -X POST https://api.payerscan.com/payment/crypto \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"merchant_id": "YOUR_MERCHANT_ID", "amount": 10, "callback_url": "https://your-server.com/webhook"}'

获取 API Key​

  1. 登录 商户控制台。
  2. 进入 Stores 页面。
  3. 在表格中找到您的商店 — API Key 和 Merchant ID 列直接显示。
  4. 点击 Copy 按钮复制。如需新密钥，使用 Regenerate 按钮。
安全警告
  • 绝不在客户端代码（浏览器、移动应用）中暴露 API Key。
  • 仅从后端服务器调用 API。
  • 如怀疑泄露，立即更换 API Key。

工作原理​

客户端 → 你的后端 → PayerScan API
                     ↑
                x-api-key 头
  1. 后端接收来自客户端的支付请求。
  2. 后端携带 x-api-key 头调用 PayerScan API。
  3. PayerScan 验证 API Key，检查商店和商户账户是否处于活跃状态。
  4. 验证通过后，处理请求并返回响应。

错误响应格式​

认证失败时，API 返回 JSON 响应：

{
  "status": "error",
  "message": "Invalid API key. Please check your API key and try again.",
  "error_code": "INVALID_API_KEY"
}

认证错误代码​

HTTP 状态码错误代码描述
401MISSING_API_KEYx-api-key 头缺失或为空。
401INVALID_API_KEYAPI Key 不正确或不属于任何活跃商店。
403ACCOUNT_INACTIVE商户账户已被禁用。请联系客服。
403STORE_INACTIVE商店已被禁用。请联系客服。
500AUTHENTICATION_FAILED认证过程中发生服务器内部错误。请稍后重试。
提示

如果收到 ACCOUNT_INACTIVE 或 STORE_INACTIVE 错误，请联系 payerscan.com 客服重新激活账户。