Pular para o conteúdo principal

Dashboard

Utilize este endpoint para consultar os indicadores do dashboard.

Ambientes Disponíveis​

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

Endpoint​

  • Método: GET
  • Endpoint: /dashboard/user
  • Autenticação: Bearer token

Query Params​

ℹ️ Datas em ISO

Os campos startDate e endDate devem ser enviados em ISO date string com horário.

Exemplo:

  • 2026-03-06T12:00:00.000Z
NomeTipoObrigatórioDescriçãoValidações
startDatestringNãoData inicial do filtroDeve ser ISO date string com horário
endDatestringNãoData final do filtroDeve ser ISO date string com horário
timezonestringNãoFuso horário usado no filtroDeve ser um timezone válido

Exemplo de Requisição​

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 seu-token-jwt'

Resposta de Sucesso​

ℹ️ Varia por tipo de conta

O retorno depende do AccountTypeEnum do usuário extraído do token.

  • SELLER: Conta Vendedor
  • ACCOUNT_MANAGER: Conta Account Manager
  • GATEWAY: Conta Gateway
  • IGAMING: Conta Transacional
⚠️ Importante: Valores em Centavos

Todos os valores monetários retornam em centavos. O saldo é calculado com cinco casas decimais, por causa da aplicação de taxas, então em centavos ele pode vir com fração: um saldo de R$ 8.488,15900 retorna 848815.9.

Conta Vendedor​

CampoTipoObrigatórioDescrição
transactionValuenumberSimValor total de transações
balancenumberSimSaldo disponível
reservenumberSimValor em reserva
toReceivenumberSimValor a receber
transactionVolumenumberSimQuantidade de transações pagas
transactionCreatedVolumenumberSimQuantidade de transações criadas
middleTicketValuenumberSimTicket médio
refundedVolumenumberSimQuantidade de transações estornadas
refundedPercentagenumberSimPercentual estornado
withdrawalRefundedValuenumberSimValor total de saques estornados
withdrawalRefundedVolumenumberSimQuantidade total de saques estornados
withdrawalRefundedValueOnCreatedDatenumberSimValor de saques estornados na data de criação
withdrawalRefundedVolumeOnCreatedDatenumberSimQuantidade de saques estornados na data de criação
frozenValuenumberNãoValor congelado
pendingDebitsnumberSimDébitos pendentes
paymentMethodsobjectSimValores por método de pagamento (ver Sub-Objeto PaymentMethods)
indexesobjectSimÍndices do período (ver Sub-Objeto Indexes)
ordersarraySimTotais por data (ver Sub-Objeto TotalsByDate)

Conta Account Manager​

CampoTipoObrigatórioDescrição
transactionValuenumberSimValor total de transações
balancenumberSimSaldo disponível
reservenumberSimValor em reserva
toReceivenumberSimValor a receber
transactionVolumenumberSimQuantidade de transações pagas
transactionCreatedVolumenumberSimQuantidade de transações criadas
middleTicketValuenumberSimTicket médio
refundedVolumenumberSimQuantidade de transações estornadas
refundedPercentagenumberSimPercentual estornado
withdrawalRefundedValuenumberSimValor total de saques estornados
withdrawalRefundedVolumenumberSimQuantidade total de saques estornados
withdrawalRefundedValueOnCreatedDatenumberSimValor de saques estornados na data de criação
withdrawalRefundedVolumeOnCreatedDatenumberSimQuantidade de saques estornados na data de criação
frozenValuenumberNãoValor congelado
pendingDebitsnumberSimDébitos pendentes
paymentMethodsobjectSimValores por método de pagamento (ver Sub-Objeto PaymentMethods)
indexesobjectSimÍndices do período (ver Sub-Objeto Indexes)
ordersarraySimTotais por data (ver Sub-Objeto TotalsByDate)

Conta Gateway​

CampoTipoObrigatórioDescrição
transactionValuenumberSimValor total de transações
balancenumberSimSaldo disponível
reservenumberSimValor em reserva
transactionVolumenumberSimQuantidade de transações pagas
transactionCreatedVolumenumberSimQuantidade de transações criadas
middleTicketValuenumberSimTicket médio
withdrawalRefundedValuenumberSimValor total de saques estornados
withdrawalRefundedVolumenumberSimQuantidade total de saques estornados
withdrawalRefundedValueOnCreatedDatenumberSimValor de saques estornados na data de criação
withdrawalRefundedVolumeOnCreatedDatenumberSimQuantidade de saques estornados na data de criação
pendingDebitsnumberSimDébitos pendentes
frozenValuenumberNãoValor congelado
ordersarraySimTotais por data (ver Sub-Objeto TotalsByDate)

Conta Transacional​

CampoTipoObrigatórioDescrição
revenuearraySimReceitas por data (ver Sub-Objeto TotalsByDate)
expensearraySimDespesas por data (ver Sub-Objeto TotalsByDate)
transactionVolumenumberSimQuantidade de transações pagas
transactionCreatedVolumenumberSimQuantidade de transações criadas
middleTicketValuenumberSimTicket médio
depositnumberSimValor total de depósitos
withdrawalsnumberSimValor total de saques
balancenumberSimSaldo disponível
averageDepositnumberSimDepósito médio
withdrawalRefundedValuenumberSimValor total de saques estornados
withdrawalRefundedVolumenumberSimQuantidade total de saques estornados
withdrawalRefundedValueOnCreatedDatenumberSimValor de saques estornados na data de criação
withdrawalRefundedVolumeOnCreatedDatenumberSimQuantidade de saques estornados na data de criação
frozenValuenumberSimValor congelado
pendingDebitsnumberSimDébitos pendentes

Sub-Objetos​

PaymentMethods​

CampoTipoObrigatórioDescrição
pixPaidValuenumberSimValor pago em PIX
pixGeneratedValuenumberSimValor gerado em PIX
pixPercentagenumberSimPercentual em PIX
cardsPaidValuenumberSimValor pago em cartões
cardsGeneratedValuenumberSimValor gerado em cartões
cardsPercentagenumberSimPercentual em cartões
billetPaidValuenumberSimValor pago em boletos
billetGeneratedValuenumberSimValor gerado em boletos
billetPercentagenumberSimPercentual em boletos

Indexes​

CampoTipoObrigatórioDescrição
pixConversionnumberSimConversão do PIX
billetConversionnumberSimConversão do boleto
creditCardConversionnumberSimConversão do cartão de crédito
preChargebackVolumenumberSimQuantidade de pré-chargebacks
preChargebackPercentagenumberSimPercentual pré-chargeback
chargebackVolumenumberSimQuantidade de chargebacks
chargebackPercentagenumberSimPercentual de chargeback
creditCardsRefusedVolumenumberSimQuantidade de cartões recusados
creditCardsRefusedPercentagenumberSimPercentual de cartões recusados
medVolumenumberNãoQuantidade de MEDs
medPercentagenumberNãoPercentual de MED

TotalsByDate​

CampoTipoObrigatórioDescrição
datestring (ISO)SimData de referência
totalnumberSimTotal no dia

Exemplo de Resposta (Seller)​

{
  "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
    }
  ]
}

Exemplo de Resposta (Gateway)​

{
  "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
    }
  ]
}

Exemplo de Resposta (Conta Transacional)​

{
  "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
}

Possíveis Erros​

CódigoDescriçãoSolução
401Credenciais inválidasVerifique suas credenciais
403Sem permissão/autorizaçãoContate o suporte
422Dados inválidos ou faltandoVerifique o formato dos dados
422ValidaçõesContate o suporte
500Erro internoContate o suporte