创建报表

使用此端点创建一个报表请求。

可用环境

生产环境

https://api.gateway.com.br/core

端点

• 方法：POST
• 端点：/report
• 认证方式：Bearer token

请求体参数

字段	类型	必填	说明	校验规则
type	string (enum) - TRANSACTION, DEPOSIT, WITHDRAWAL, MED, WALLET, ACCOUNT, ACCOUNT_FINANCIAL_SUMMARY, WALLET_DAILY_BALANCES	是	报表类型	必须为有效的枚举值；ACCOUNT 和 ACCOUNT_FINANCIAL_SUMMARY 要求用户具有 manager 角色
filters	object	是	报表筛选条件（参见子对象 Filters）	必须为非空对象

⚠️ ACCOUNT 与 ACCOUNT_FINANCIAL_SUMMARY 需要 manager 角色

这两类报表只能由具有 manager 角色的用户申请。没有该角色的账号尝试生成时会收到 403。

子对象

Filters

ℹ️ 使用 ISO 日期

startDate 和 endDate 必须以带时间的 ISO date string 格式传入。

示例：

• 2026-03-06T12:00:00.000Z

⚠️ WALLET_DAILY_BALANCES 的最大时间跨度

当 type 为 WALLET_DAILY_BALANCES 时，startDate 与 endDate 之间的跨度不能超过 60 天。

字段	类型	必填	说明	校验规则
startDate	string	是	筛选的起始日期	必须为带时间的 ISO date string
endDate	string	是	筛选的结束日期	必须为带时间的 ISO date string；若 type 为 WALLET_DAILY_BALANCES，startDate 与 endDate 之间的跨度最多为 60 天
storeId	string (UUID v4)	否	店铺的标识	可选（需要筛选时传入）
userId	string (UUID v4)	否	用户的标识	可选（需要筛选时传入）
status	string[] (enum) - PENDING, PIX_QRCODE_GENERATED, PAID, PROCESSING_REFUND, PROCESSING_INFRACTION, REFUNDED, INFRACTION, FAILED, BLOCKED, PROCESSING, PROCESSED, CANCELED, REJECTED, APPEALED, APPROVED	否	用于筛选的状态	必须为非空且不含重复项的数组
paymentMethod	string[] (enum) - PIX	否	支付方式	必须为非空且不含重复项的数组
acquirer	string[]	否	报表涉及的收单机构	必须为非空且不含重复项的数组

请求示例

cURL

curl --request POST \
--url https://api.gateway.com.br/core/report \
--header 'Authorization: Bearer your-jwt-token' \
--header 'Content-Type: application/json' \
--data '{
  "type": "TRANSACTION",
  "filters": {
    "startDate": "2026-03-06T00:00:00.000Z",
    "endDate": "2026-03-06T23:59:59.999Z"
  }
}'

JavaScript

const response = await fetch('https://api.gateway.com.br/core/report', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your-jwt-token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'TRANSACTION',
    filters: {
      startDate: '2026-03-06T00:00:00.000Z',
      endDate: '2026-03-06T23:59:59.999Z'
    }
  })
});
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）

响应示例

{
  "id": "553e8400-e29b-41d4-a716-436251480000",
  "status": "PENDING",
  "type": "TRANSACTION"
}

可能的错误

状态码	说明	处理方式
401	凭据无效	请检查您的凭据
403	无权限或未授权	请联系技术支持
422	数据无效或缺失	请检查数据格式
422	校验失败	请联系技术支持
500	内部错误	请联系技术支持