Listar Transações da Conta

Lista as transações de uma conta bancária específica com suporte a paginação e filtros.

Endpoint

Método e URL:

GET /v1/items/:itemId/accounts/:accountId/transactions

Parâmetros da URL:

• itemId (string, obrigatório): Identificador único do item
• accountId (string, obrigatório): Identificador único da conta bancária

Parâmetros de consulta:

• ids (string ou array de strings, opcional): Um ou mais IDs específicos para filtrar as transações
• page (número, opcional): Número da página (padrão: 1, mínimo: 1)
• limit (número, opcional): Quantidade de registros por página (padrão: 20, mínimo: 1, máximo: 500)
• from (data ISO 8601, opcional): Filtra transações com transactionAt maior ou igual à data informada
• to (data ISO 8601, opcional): Filtra transações com transactionAt menor ou igual à data informada
• createdAtFrom (data ISO 8601, opcional): Filtra transações com createdAt maior ou igual à data informada. Útil para sincronização incremental

Campos da Transação

• id: Identificador único da transação
• accountId: Identificador da conta bancária associada
• providerId: Identificador da transação no provedor de dados (pode ser null)
• description: Descrição processada da transação
• descriptionRaw: Descrição original da transação
• status: Status da transação (PENDING = pendente, POSTED = processada)
• type: Tipo da transação (CREDIT = crédito, DEBIT = débito)
• amount: Valor da transação formatado como string
• amountInCurrency: Valor da transação convertido para a moeda da conta, formatado como string (pode ser null)
• currency: Código da moeda da transação
• operationType: Tipo específico da operação bancária (veja Tipos de Operação). Pode ser null
• payer: Dados do pagador da transação
  • name: Nome do pagador
  • accountNumber: Número da conta do pagador
  • branchNumber: Número da agência do pagador
  • routingNumber: Número de roteamento do banco
  • routingNumberIspb: Código ISPB do banco
  • documentType: Tipo do documento (CPF, CNPJ)
  • document: Número do documento
• receiver: Dados do recebedor da transação (mesma estrutura do pagador)
• paymentMethod: Método de pagamento utilizado
• reason: Motivo/finalidade da transação
• transactionAt: Data e hora em que a transação ocorreu
• createdAt: Data de criação
• updatedAt: Data da última atualização

Paginação

• page: Página atual
• totalPages: Total de páginas disponíveis

Resposta

Resposta de sucesso (200):

{
  "status": "success",
  "data": {
    "pagination": {
      "page": 1,
      "totalPages": 5
    },
    "transactions": [
      {
        "id": "uuid",
        "accountId": "uuid",
        "providerId": "string | null",
        "description": "string",
        "descriptionRaw": "string",
        "status": "PENDING | POSTED",
        "type": "CREDIT | DEBIT",
        "amount": "string",
        "amountInCurrency": "string | null",
        "currency": "string",
        "operationType": "TED | DOC | PIX | ... | null",
        "payer": {
          "name": "string",
          "accountNumber": "string",
          "branchNumber": "string",
          "routingNumber": "string",
          "routingNumberIspb": "string",
          "documentType": "string",
          "document": "string"
        },
        "receiver": {
          "name": "string",
          "accountNumber": "string",
          "branchNumber": "string",
          "routingNumber": "string",
          "routingNumberIspb": "string",
          "documentType": "string",
          "document": "string"
        },
        "paymentMethod": "string",
        "reason": "string",
        "transactionAt": "timestamp",
        "createdAt": "timestamp",
        "updatedAt": "timestamp"
      }
    ]
  }
}

Tipos de Operação

O campo operationType indica a natureza da operação bancária. Pode ser null quando o provedor não informa o tipo. Os valores possíveis são: