API 简介
概述
Avista 公共 API 是一个用于集成 PIX 支付服务和账户管理的综合平台。我们的 API 允许您:
- 生成动态 PIX 收款码以接收付款
- 向任意密钥发送 PIX 付款
- 通过二维码发送 PIX 付款
- 实时查询余额
- 管理交易退款
- 将即时支付集成到您的应用程序中
环境
生产环境
https://api.public.firebanking.com.br认证
所有 API 端点(除令牌生成端点外)都需要 Bearer token 认证。认证流程遵循 OAuth 2.0 标准,并使用 X.509 证书:
通过 Avista 门户申请您的 clientId 和 clientSecret
在您的环境中安装提供的客户端证书
使用 /api/auth/token 端点配合您的凭证和证书生成 Bearer token
在所有请求的 Authorization: Bearer {token} 请求头中包含该令牌
生成的令牌有效期为 30 分钟,到期后必须续期。
HTTP 状态码
API 使用标准 HTTP 状态码来表示请求的成功或失败:
| 状态码 | 含义 | 描述 |
|---|---|---|
200 | OK | 请求成功 (GET) |
201 | Created | 资源创建成功 (POST) |
400 | Bad Request | 请求数据无效 |
401 | Unauthorized | 令牌缺失、无效或已过期 |
404 | Not Found | 资源未找到 |
500 | Internal Server Error | 服务器内部错误 |
日期格式
API 中的所有日期均遵循 ISO 8601 标准,使用 UTC 时区:
2024-01-15T10:30:00.000Z快速开始
技术支持
如有技术问题或需要支持,请联系我们: