Fire Bankingdocs

Buscar transações da conta

GET /api/transactions

Retorna transações da conta autenticada no formato publico amigavel com paginação.

Características:

  • Valores convertidos para reais (2 decimais)
  • Status e tipos mapeados para português
  • Documentos de contraparte mascarados
  • Intervalo máximo de 31 dias entre startDate e endDate

Autenticação

Requer token Bearer no header Authorization.

Query Parameters

ParâmetroTipoObrigatórioDescrição
pageintegerNãoNúmero da página (1-indexed). Default: 1
sizeintegerNãoQuantidade de registros por página (max 100). Default: 20
statusstringNãoFiltro por status: PENDING, CONFIRMED, ERROR
typestringNãoFiltro por tipo: PAYMENT, WITHDRAW, REFUND_IN, REFUND_OUT
startDatestringNãoData inicial (ISO 8601, ex: 2025-01-01). Default: últimos 31 dias
endDatestringNãoData final (ISO 8601, ex: 2025-01-31). Default: data atual
externalIdstringNãoFiltro por externalId da transação
endToEndIdstringNãoFiltro por endToEndId (e2eId) da transação

Mapeamento de Status e Tipos

Valor OriginalValor Exibido
PENDINGPendente
CONFIRMEDConfirmado
ERRORError
PAYMENTPix in
WITHDRAWPix out
REFUND_INRefund in
REFUND_OUTRefund out

Tipo de Movimento: Pix in e Refund out = CREDIT; Pix out e Refund in = DEBIT.

Response (200)

{
  "data": [
    {
      "transactionId": "12345",
      "externalId": "ext-123456",
      "status": "Confirmado",
      "operationType": "Pix in",
      "movementType": "CREDIT",
      "originalAmount": 100.00,
      "feeAmount": 1.00,
      "finalAmount": 99.00,
      "endToEndId": "E12345678901234567890123456789012",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "processedAt": "2025-01-15T10:30:05.000Z",
      "counterpart": {
        "name": "João Silva",
        "document": "***.456.789-**",
        "bank": {
          "bankISPB": "00000000",
          "bankName": "Banco do Brasil",
          "bankCode": "001",
          "accountBranch": "0001",
          "accountNumber": "123456-7"
        }
      }
    }
  ],
  "metadata": {
    "page": 1,
    "size": 20,
    "total": 150,
    "totalPages": 8,
    "hasNext": true,
    "hasPrevious": false
  }
}

Erros

StatusDescrição
400Parâmetros inválidos ou intervalo de datas excede 31 dias
401Token não fornecido ou inválido

Nesta página