API 参考文档
FyPay API 提供以下端点分组用于集成:
| 方法 | 端点 | 描述 |
|---|
POST | /api/auth/token | 生成 JWT 访问令牌 |
| 方法 | 端点 | 描述 |
|---|
GET | /api/balance | 查询账户余额 |
| 方法 | 端点 | 描述 |
|---|
POST | /api/pix/cash-in | 生成 PIX 收款(Cash-In) |
POST | /api/pix/cash-out | 发送 PIX 付款(Cash-Out) |
POST | /api/pix/cash-out-qrcode | 通过 PIX 二维码付款 |
POST | /api/pix/refund-in/\{id\} | 请求退款 |
GET | /api/pix/transaction/\{id\} | 查询交易状态 |
GET | /api/transactions | 搜索账户交易 |
GET | /api/pix/transactions/pix-key/\{pixKey\} | 按 PIX 密钥列出交易 |
GET | /api/pix/transactions/pix-key/\{pixKey\}/\{identifier\} | 按 PIX 密钥查询交易 |
| 方法 | 端点 | 描述 |
|---|
GET | /api/med | 按条件查询 MED 请求 |
| 方法 | 端点 | 描述 |
|---|
POST | /api/resend-webhook/\{transactionIdentifier\} | 重新发送 webhook |
Webhook URL 和签名密钥只能在面板(https://banking.fypay.me)的 设置 → Webhooks 中配置。请参阅 配置 Webhooks。
Base URL:https://api.fypay.me。所有端点(除令牌生成外)均需要通过 Bearer 令牌进行身份验证。令牌生成要求 mTLS:客户端证书在 TLS 握手中出示。
请参阅身份验证指南了解更多详情。