API 简介

概述

FyPay 公共 API 是一个用于集成 PIX 支付服务和账户管理的综合平台。我们的 API 允许您：

所有 API 端点都位于 /api 前缀下（例如 https://api.fypay.me/api/balance）。健康检查是唯一不在该前缀下的路由。

所有 API 端点（除令牌生成端点外）都需要 Bearer token 认证。令牌通过您的 OAuth 2.0 凭证以及在 TLS 握手中出示的 X.509 客户端证书（mTLS）获取：

在 FyPay 控制面板中进入 设置 → 凭证，生成您的 clientId 和 clientSecret。clientSecret 仅显示一次。

使用已关联到您账户的 X.509 证书（PEM、RSA 2048、有效期 2 年）及其私钥。

使用您的凭证调用 POST https://api.fypay.me/api/auth/token，并在 TLS 握手中出示证书（例如 curl --cert client.crt --key client.key）。

在其他所有请求中通过 Authorization: Bearer <token> 请求头携带令牌。这些请求不需要证书。

令牌的有效期由响应中的 expires_in 字段（单位：秒）给出。请在令牌过期前续期。

API 使用标准 HTTP 状态码来表示请求的成功或失败：