Criar Relatório

Utilize este endpoint para criar uma solicitação de relatório.

Ambientes Disponíveis

Produção

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

Endpoint

• Método: POST
• Endpoint: /report
• Autenticação: Bearer token

Body Params

Campo	Tipo	Obrigatório	Descrição	Validações
type	string (enum) - TRANSACTION, DEPOSIT, WITHDRAWAL, MED, WALLET, ACCOUNT, WALLET_DAILY_BALANCES	Sim	Tipo do relatório	Deve ser um enum válido
filters	object	Sim	Filtros do relatório (ver Sub-Objeto Filters)	Deve ser objeto não vazio

Sub-Objetos

Filters

ℹ️ 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

⚠️ Intervalo máximo para WALLET_DAILY_BALANCES

Quando type for WALLET_DAILY_BALANCES, o intervalo entre startDate e endDate não pode ultrapassar 60 dias.

Campo	Tipo	Obrigatório	Descrição	Validações
startDate	string	Sim	Data inicial do filtro	Deve ser ISO date string com horário
endDate	string	Sim	Data final do filtro	Deve ser ISO date string com horário; se type for WALLET_DAILY_BALANCES, o intervalo entre startDate e endDate deve ser de no máximo 60 dias
storeId	string (UUID v4)	Não	Identificador da loja	Opcional (enviar se desejar filtrar)
userId	string (UUID v4)	Não	Identificador do usuário	Opcional (enviar se desejar filtrar)
status	string[] (enum) - PENDING, PIX_QRCODE_GENERATED, PAID, PROCESSING_REFUND, PROCESSING_INFRACTION, REFUNDED, INFRACTION, FAILED, BLOCKED, PROCESSING, PROCESSED, CANCELED, REJECTED, APPEAL, APPROVED	Não	Status para filtrar	Deve ser um array não vazio e sem duplicados
paymentMethod	string[] (enum) - PIX	Não	Métodos de pagamento	Deve ser um array não vazio e sem duplicados
acquirer	string[]	Não	Adquirentes do relatório	Deve ser um array não vazio e sem duplicados

Exemplo de Requisição

cURL

curl --request POST \
--url https://api.gateway.com.br/core/report \
--header 'Authorization: Bearer seu-token-jwt' \
--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 seu-token-jwt',
    '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();

Resposta de Sucesso

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador do relatório
status	string (enum)	Sim	Status do relatório (PENDING, PROCESSING, FAILED, PROCESSED)
type	string (enum)	Sim	Tipo do relatório (TRANSACTION, DEPOSIT, WITHDRAWAL, MED, WALLET, ACCOUNT, WALLET_DAILY_BALANCES)

Exemplo de Resposta

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

Possíveis Erros

Código	Descrição	Solução
401	Credenciais inválidas	Verifique suas credenciais
403	Sem permissão/autorização	Contate o suporte
422	Dados inválidos ou faltando	Verifique o formato dos dados
422	Validações	Contate o suporte
500	Erro interno	Contate o suporte