查询报表
使用此端点按 id 查询某个报表。
可用环境
- 生产环境
https://api.gateway.com.br/core
端点
- 方法：
GET - 端点：
/report/{id} - 认证方式：Bearer token
路径参数
| 名称 | 类型 | 必填 | 说明 | 校验规则 |
|---|---|---|---|---|
id | string (UUID v4) | 是 | 报表的标识 | 必须为有效的 UUID v4 |
请求示例
- cURL
- JavaScript
curl --request GET \
--url https://api.gateway.com.br/core/report/553e8400-e29b-41d4-a716-436251480000 \
--header 'Authorization: Bearer your-jwt-token'
const response = await fetch('https://api.gateway.com.br/core/report/553e8400-e29b-41d4-a716-436251480000', {
method: 'GET',
headers: {
'Authorization': 'Bearer your-jwt-token'
}
});
const data = await response.json();
成功响应
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 是 | 报表的标识 |
status | string (enum) | 是 | 报表状态（PENDING、PROCESSING、FAILED、PROCESSED） |
type | string (enum) | 是 | 报表类型（TRANSACTION、DEPOSIT、WITHDRAWAL、MED、WALLET、ACCOUNT、ACCOUNT_FINANCIAL_SUMMARY、WALLET_DAILY_BALANCES） |
user | object | 是 | 用户信息（参见子对象 User） |
origin | string (enum) | 否 | 报表来源（ADMIN、USER） |
filters | object | 是 | 报表使用的筛选条件（参见子对象 Filters） |
file | object | 否 | 报表文件（参见子对象 File） |
expirationDate | string (ISO) | 否 | 文件的过期时间 |
errorMessage | string | 否 | 错误信息 |
createdAt | string (ISO) | 是 | 创建时间 |
updatedAt | string (ISO) | 是 | 最后更新时间 |
子对象
User
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | string | 是 | 用户的标识 |
name | string | 是 | 用户名称 |
email | string | 是 | 用户邮箱 |
Filters
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
startDate | string | 是 | 筛选的起始日期 |
endDate | string | 是 | 筛选的结束日期 |
storeId | string (UUID v4) | 否 | 店铺的标识 |
userId | string (UUID v4) | 否 | 用户的标识 |
status | string[] | 否 | 已应用的状态列表 |
paymentMethod | string[] | 否 | 支付方式 |
acquirer | string[] | 否 | 报表涉及的收单机构 |
File
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
key | string | 是 | 文件的键 |
isPrivate | boolean | 是 | 标识文件是否为私有 |
url | string | 是 | 访问文件的地址 |
响应示例
{
"id": "553e8400-e29b-41d4-a716-436251480000",
"status": "PROCESSED",
"type": "TRANSACTION",
"user": {
"id": "553e8400-e29b-41d4-a716-436251480111",
"name": "Loja Exemplo",
"email": "contato@lojaexemplo.com"
},
"origin": "USER",
"filters": {
"startDate": "2026-03-06T00:00:00.000Z",
"endDate": "2026-03-06T23:59:59.999Z",
"status": ["PAID"],
"paymentMethod": ["PIX"]
},
"file": {
"key": "report-2026-03-06-553e8400-e29b-41d4-a716-436251480000-CSV",
"isPrivate": true,
"url": "signed-url"
},
"expirationDate": null,
"errorMessage": null,
"createdAt": "2026-03-06T12:49:04.681Z",
"updatedAt": "2026-03-06T12:49:04.681Z"
}
可能的错误
| 状态码 | 说明 | 处理方式 |
|---|---|---|
| 401 | 凭据无效 | 请检查您的凭据 |
| 403 | 无权限或未授权 | 请联系技术支持 |
| 404 | 未找到记录 | 请检查传入的 id |
| 422 | 数据无效或缺失 | 请检查数据格式 |
| 422 | 校验失败 | 请联系技术支持 |
| 500 | 内部错误 | 请联系技术支持 |