跳转至

账户状态查询接口

概述

通过本接口查询当前用户的账户信息，包括账户余额、状态、Webhook 配置等基本信息。该接口使用当前 API 凭证对应的用户身份，无需额外参数。

完整路径： http://api.globfax.com/api/v2/account/status

接口详情

项目 说明
方法 GET
路径 /api/v2/account/status
认证 需要在请求头中添加 X-API-Key 和 X-API-Secret，详见 认证指南。
请求头 无特殊要求，只需认证头即可。

请求示例

cURL

curl -X GET "http://api.globfax.com/api/v2/account/status" \
  -H "X-API-Key: your_api_key_here" \
  -H "X-API-Secret: your_api_secret_here"

原始 HTTP 请求

GET /api/v2/account/status HTTP/1.1
Host: api.globfax.com
X-API-Key: your_api_key_here
X-API-Secret: your_api_secret_here

响应格式

成功响应

{
  "success": true,
  "message": "Account details retrieved",
  "data": {
    "uid": "TENANT123456",
    "name": "张三科技有限公司",
    "balance": 1500.50,
    "webhook_url": "https://example.com/api/webhook",
    "status": "active",
    "created_at": "2024-01-15 10:30:00",
    "updated_at": "2025-02-20 14:25:30"
  }
}

认证失败响应

{
  "success": false,
  "message": "缺少API密钥或秘钥",
  "errors": ""
}

账户权限不足响应

{
  "success": false,
  "message": "无API访问权限",
  "errors": ""
}

通用错误格式

关于错误响应的通用格式及常见 HTTP 状态码，请参考 API 概述 中的「错误处理」章节。

字段说明

字段名 类型 说明 示例值
uid string 租户唯一标识符（企业/组织ID） "TENANT123456"
name string 用户/企业名称 "张三科技有限公司"
balance float 账户余额（单位：元） 1500.50
webhook_url string 配置的Webhook回调地址 "https://example.com/api/webhook"
status string 账户状态 "active"（活跃）, "suspended"（暂停）, "inactive"（未激活）
created_at string 账户创建时间（Y-m-d H:i:s格式） "2024-01-15 10:30:00"
updated_at string 账户信息最后更新时间（Y-m-d H:i:s格式） "2025-02-20 14:25:30"

常见问题

1. 为什么查询不到余额信息？

  • 确保使用的 API 凭证对应正确的账户。
  • 检查账户状态是否为 active（活跃）。
  • 如为新账户，可能需要先充值激活。

2. Webhook URL 显示为 null 怎么办？

  • 前往管理后台「开发者」菜单 → 「API 设置」页面。
  • 在「回调网址（Webhook Url）」字段填写有效的公网可访问地址。
  • 保存后重新查询即可看到更新后的地址。

3. 如何更新账户信息？

  • 账户名称等基本信息需在管理后台「账户设置」中修改。
  • Webhook 回调地址在「API 设置」页面修改。
  • 修改后，本接口会返回更新后的信息。

API 调用频率

关于接口调用频率限制等通用约定，请参考 API 概述 中的「频率限制与重试」章节。

下一步