仪表板

使用此端点查询仪表板的各项指标。

可用环境

生产环境

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

端点

方法：GET
端点：/dashboard/user
认证方式：Bearer token

查询参数

ℹ️ 使用 ISO 日期

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

示例：

2026-03-06T12:00:00.000Z

名称	类型	必填	说明	校验规则
`startDate`	string	否	筛选的起始日期	必须为带时间的 ISO date string
`endDate`	string	否	筛选的结束日期	必须为带时间的 ISO date string
`timezone`	string	否	筛选所使用的时区	必须为有效的时区

请求示例

cURL
JavaScript

curl --request GET \
--url https://api.gateway.com.br/core/dashboard/user?startDate=2026-03-06T00:00:00.000Z&endDate=2026-03-06T23:59:59.999Z&timezone=America%2FSao_Paulo \
--header 'Authorization: Bearer your-jwt-token'

const params = new URLSearchParams({
  startDate: '2026-03-06T00:00:00.000Z',
  endDate: '2026-03-06T23:59:59.999Z',
  timezone: 'America/Sao_Paulo'
});

const response = await fetch(`https://api.gateway.com.br/core/dashboard/user?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer your-jwt-token'
  }
});
const data = await response.json();

成功响应

ℹ️ 返回内容随账号类型而变

返回内容取决于从 token 中解析出的用户 AccountTypeEnum。

SELLER：卖家账号
ACCOUNT_MANAGER：客户经理账号
GATEWAY：网关账号
IGAMING：交易账号

⚠️ 重要：金额以分为单位

所有金额均以分返回。由于手续费的计算方式，余额保留五位小数，因此以分为单位时可能带有小数部分：余额 R$ 8,488.15900 会返回 848815.9。

卖家账号

字段	类型	必填	说明
`transactionValue`	number	是	交易总金额
`balance`	number	是	可用余额
`reserve`	number	是	处于准备金中的金额
`toReceive`	number	是	待收款金额
`transactionVolume`	number	是	已支付交易的笔数
`transactionCreatedVolume`	number	是	已创建交易的笔数
`middleTicketValue`	number	是	平均客单价
`refundedVolume`	number	是	退款笔数
`refundedPercentage`	number	是	退款占比
`withdrawalRefundedValue`	number	是	退回提现的总金额
`withdrawalRefundedVolume`	number	是	退回提现的总笔数
`withdrawalRefundedValueOnCreatedDate`	number	是	按创建日期统计的退回提现金额
`withdrawalRefundedVolumeOnCreatedDate`	number	是	按创建日期统计的退回提现笔数
`frozenValue`	number	否	被冻结的金额
`pendingDebits`	number	是	待处理的扣款
`paymentMethods`	object	是	按支付方式统计的金额（参见子对象 `PaymentMethods`）
`indexes`	object	是	该周期的指标（参见子对象 `Indexes`）
`orders`	array	是	按日期统计的合计（参见子对象 `TotalsByDate`）

客户经理账号

字段	类型	必填	说明
`transactionValue`	number	是	交易总金额
`balance`	number	是	可用余额
`reserve`	number	是	处于准备金中的金额
`toReceive`	number	是	待收款金额
`transactionVolume`	number	是	已支付交易的笔数
`transactionCreatedVolume`	number	是	已创建交易的笔数
`middleTicketValue`	number	是	平均客单价
`refundedVolume`	number	是	退款笔数
`refundedPercentage`	number	是	退款占比
`withdrawalRefundedValue`	number	是	退回提现的总金额
`withdrawalRefundedVolume`	number	是	退回提现的总笔数
`withdrawalRefundedValueOnCreatedDate`	number	是	按创建日期统计的退回提现金额
`withdrawalRefundedVolumeOnCreatedDate`	number	是	按创建日期统计的退回提现笔数
`frozenValue`	number	否	被冻结的金额
`pendingDebits`	number	是	待处理的扣款
`paymentMethods`	object	是	按支付方式统计的金额（参见子对象 `PaymentMethods`）
`indexes`	object	是	该周期的指标（参见子对象 `Indexes`）
`orders`	array	是	按日期统计的合计（参见子对象 `TotalsByDate`）

网关账号

字段	类型	必填	说明
`transactionValue`	number	是	交易总金额
`balance`	number	是	可用余额
`reserve`	number	是	处于准备金中的金额
`transactionVolume`	number	是	已支付交易的笔数
`transactionCreatedVolume`	number	是	已创建交易的笔数
`middleTicketValue`	number	是	平均客单价
`withdrawalRefundedValue`	number	是	退回提现的总金额
`withdrawalRefundedVolume`	number	是	退回提现的总笔数
`withdrawalRefundedValueOnCreatedDate`	number	是	按创建日期统计的退回提现金额
`withdrawalRefundedVolumeOnCreatedDate`	number	是	按创建日期统计的退回提现笔数
`pendingDebits`	number	是	待处理的扣款
`frozenValue`	number	否	被冻结的金额
`orders`	array	是	按日期统计的合计（参见子对象 `TotalsByDate`）

交易账号

字段	类型	必填	说明
`revenue`	array	是	按日期统计的收入（参见子对象 `TotalsByDate`）
`expense`	array	是	按日期统计的支出（参见子对象 `TotalsByDate`）
`transactionVolume`	number	是	已支付交易的笔数
`transactionCreatedVolume`	number	是	已创建交易的笔数
`middleTicketValue`	number	是	平均客单价
`deposit`	number	是	充值总金额
`withdrawals`	number	是	提现总金额
`balance`	number	是	可用余额
`averageDeposit`	number	是	平均充值金额
`withdrawalRefundedValue`	number	是	退回提现的总金额
`withdrawalRefundedVolume`	number	是	退回提现的总笔数
`withdrawalRefundedValueOnCreatedDate`	number	是	按创建日期统计的退回提现金额
`withdrawalRefundedVolumeOnCreatedDate`	number	是	按创建日期统计的退回提现笔数
`frozenValue`	number	是	被冻结的金额
`pendingDebits`	number	是	待处理的扣款

子对象

PaymentMethods

字段	类型	必填	说明
`pixPaidValue`	number	是	通过 PIX 支付的金额
`pixGeneratedValue`	number	是	通过 PIX 生成的金额
`pixPercentage`	number	是	PIX 的占比
`cardsPaidValue`	number	是	通过银行卡支付的金额
`cardsGeneratedValue`	number	是	通过银行卡生成的金额
`cardsPercentage`	number	是	银行卡的占比
`billetPaidValue`	number	是	通过票据支付的金额
`billetGeneratedValue`	number	是	通过票据生成的金额
`billetPercentage`	number	是	票据的占比

Indexes

字段	类型	必填	说明
`pixConversion`	number	是	PIX 转化率
`billetConversion`	number	是	票据转化率
`creditCardConversion`	number	是	信用卡转化率
`preChargebackVolume`	number	是	预拒付笔数
`preChargebackPercentage`	number	是	预拒付占比
`chargebackVolume`	number	是	拒付笔数
`chargebackPercentage`	number	是	拒付占比
`creditCardsRefusedVolume`	number	是	银行卡被拒笔数
`creditCardsRefusedPercentage`	number	是	银行卡被拒占比
`medVolume`	number	否	MED 笔数
`medPercentage`	number	否	MED 占比

TotalsByDate

字段	类型	必填	说明
`date`	string (ISO)	是	参考日期
`total`	number	是	当天合计

响应示例（卖家）

{
  "transactionValue": 150000,
  "balance": 50000,
  "reserve": 10000,
  "toReceive": 90000,
  "transactionVolume": 30,
  "transactionCreatedVolume": 40,
  "middleTicketValue": 5000,
  "refundedVolume": 1,
  "refundedPercentage": 3.3,
  "withdrawalRefundedValue": 1200,
  "withdrawalRefundedVolume": 3,
  "withdrawalRefundedValueOnCreatedDate": 800,
  "withdrawalRefundedVolumeOnCreatedDate": 2,
  "frozenValue": 2000,
  "pendingDebits": 1000,
  "paymentMethods": {
    "pixPaidValue": 60000,
    "pixGeneratedValue": 65000,
    "pixPercentage": 40,
    "cardsPaidValue": 70000,
    "cardsGeneratedValue": 75000,
    "cardsPercentage": 47,
    "billetPaidValue": 20000,
    "billetGeneratedValue": 25000,
    "billetPercentage": 13
  },
  "indexes": {
    "pixConversion": 92,
    "billetConversion": 65,
    "creditCardConversion": 78,
    "preChargebackVolume": 1200,
    "preChargebackPercentage": 0.8,
    "chargebackVolume": 500,
    "chargebackPercentage": 0.3,
    "creditCardsRefusedVolume": 3000,
    "creditCardsRefusedPercentage": 2.0,
    "medVolume": 200,
    "medPercentage": 0.1
  },
  "orders": [
    {
      "date": "2026-03-06",
      "total": 50000
    },
    {
      "date": "2026-03-07",
      "total": 100000
    }
  ]
}

响应示例（网关）

{
  "transactionValue": 120000,
  "balance": 40000,
  "reserve": 8000,
  "transactionVolume": 20,
  "transactionCreatedVolume": 25,
  "middleTicketValue": 6000,
  "withdrawalRefundedValue": 900,
  "withdrawalRefundedVolume": 2,
  "withdrawalRefundedValueOnCreatedDate": 500,
  "withdrawalRefundedVolumeOnCreatedDate": 1,
  "pendingDebits": 900,
  "frozenValue": 1500,
  "orders": [
    {
      "date": "2026-03-06",
      "total": 45000
    },
    {
      "date": "2026-03-07",
      "total": 75000
    }
  ]
}

响应示例（交易账号）

{
  "revenue": [
    {
      "date": "2026-03-06",
      "total": 90000
    },
    {
      "date": "2026-03-07",
      "total": 110000
    }
  ],
  "expense": [
    {
      "date": "2026-03-06",
      "total": 30000
    },
    {
      "date": "2026-03-07",
      "total": 35000
    }
  ],
  "transactionVolume": 18,
  "transactionCreatedVolume": 25,
  "middleTicketValue": 8000,
  "deposit": 200000,
  "withdrawals": 80000,
  "balance": 120000,
  "averageDeposit": 10000,
  "withdrawalRefundedValue": 700,
  "withdrawalRefundedVolume": 1,
  "withdrawalRefundedValueOnCreatedDate": 700,
  "withdrawalRefundedVolumeOnCreatedDate": 1,
  "frozenValue": 5000,
  "pendingDebits": 2500
}

可能的错误

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

可用环境​

端点​

查询参数​

请求示例​

成功响应​

卖家账号​

客户经理账号​

网关账号​

交易账号​

子对象​

PaymentMethods​

Indexes​

TotalsByDate​

响应示例（卖家）​

响应示例（网关）​

响应示例（交易账号）​

可能的错误​