Consulta de Extrato da Conta

Retorna o histórico de movimentações financeiras (entradas e saídas) de uma conta específica.

Este endpoint retorna o extrato completo da conta bancária informada por accountId, listando as movimentações financeiras associadas — como PIX enviados e recebidos, transferências, tarifas e pagamentos de QR Code.

O accountId deve ser obtido através do endpoint Consulta de Conta Bancária ou do campo accounts[].id retornado em Consulta de Perfil — Pessoa Física ou Jurídica.

É possível realizar a paginação do resultado para consultar grandes volumes de transações.

O retorno inclui:

  • amount: valor da transação

  • category: tipo de operação (Pix, TEF, QR Code, Tarifa, etc.)

  • credit: indica se foi entrada (true) ou saída (false)

  • beneficiaryName: nome do favorecido ou remetente

  • status e externalStatus: estados de processamento da operação

  • createdAt: data e hora da transação

Este endpoint é protegido e requer o uso do cabeçalho Authorization: Bearer <token> e x-tenant-id

Endpoint Extrato

GET /accounts/{accountId}/transactions

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

x-tenant-id

Tenant ID

Query Parameters

Name
Type
Description

page

Number

Página atual

startDate

Date

yyyy-MM-dd

endDate

Date

yyyy-MM-dd

{
  "data": [
    {
      "id": "bfa8e921-29e2-41b2-b7a1-6a4cb8d8d112",
      "amount": 150.75,
      "status": "DONE",
      "externalStatus": "SUCCESS",
      "category": "Pix enviado",
      "beneficiaryName": "Lucas Andrade da Silva",
      "type": "PIX",
      "credit": false,
      "createdAt": "2025-10-08T20:12:17.703Z"
    },
    {
      "id": "c2d8af23-4d67-4eab-b4b2-9b0b0b34e59b",
      "amount": 42.90,
      "status": "DONE",
      "externalStatus": "SUCCESS",
      "category": "Pix recebido",
      "beneficiaryName": "Digital Minds Tecnologia LTDA",
      "type": "PIX",
      "credit": true,
      "createdAt": "2025-10-08T19:57:22.000Z"
    },
    {
      "id": "ad5cf04e-0f92-4b9e-9df9-9d8e5f74ce7b",
      "amount": 0.50,
      "status": "DONE",
      "externalStatus": "PROCESSING",
      "category": "Tarifa bancária",
      "beneficiaryName": "Banco Stric Global",
      "type": "FEE",
      "credit": false,
      "createdAt": "2025-10-08T19:35:40.000Z"
    },
    {
      "id": "ec51c6a2-01e5-4b1f-a6b8-35e8c75e5b14",
      "amount": 350.00,
      "status": "DONE",
      "externalStatus": "SUCCESS",
      "category": "Pix recebido",
      "beneficiaryName": "M. C. Ribeiro Consultoria",
      "type": "PIX",
      "credit": true,
      "createdAt": "2025-10-08T18:49:00.000Z"
    },
    {
      "id": "ae729c56-9b02-4db8-9c13-47c3fce73499",
      "amount": 120.00,
      "status": "DONE",
      "externalStatus": "PROCESSING",
      "category": "Transferência enviada",
      "beneficiaryName": "João Pedro Almeida",
      "type": "TED",
      "credit": false,
      "createdAt": "2025-10-07T22:13:17.000Z"
    },
    {
      "id": "f65ce7bc-18b8-4894-9e5b-09e3a5ff7b10",
      "amount": 25.00,
      "status": "DONE",
      "externalStatus": "SUCCESS",
      "category": "Pix enviado",
      "beneficiaryName": "Eduarda Santos",
      "type": "PIX",
      "credit": false,
      "createdAt": "2025-10-07T21:12:44.000Z"
    },
    {
      "id": "1bfb67e3-445f-4ec7-a48d-6f89e7b44218",
      "amount": 89.99,
      "status": "DONE",
      "externalStatus": "SUCCESS",
      "category": "Pix recebido",
      "beneficiaryName": "Mundo Pet LTDA",
      "type": "PIX",
      "credit": true,
      "createdAt": "2025-10-07T17:02:19.000Z"
    },
    {
      "id": "dbb3c771-7339-4a43-8215-d6503b47e4bb",
      "amount": 7.50,
      "status": "DONE",
      "externalStatus": "SUCCESS",
      "category": "QR Code pago",
      "beneficiaryName": "Supermercado Central",
      "type": "PIX_QRCODE",
      "credit": false,
      "createdAt": "2025-10-07T14:25:36.000Z"
    },
    {
      "id": "a9b33b12-3f0b-4f32-9f2f-168b95f804b3",
      "amount": 200.00,
      "status": "DONE",
      "externalStatus": "SUCCESS",
      "category": "Pix recebido",
      "beneficiaryName": "Carlos Henrique Lopes",
      "type": "PIX",
      "credit": true,
      "createdAt": "2025-10-06T23:59:58.000Z"
    },
    {
      "id": "e87d1a5e-04c5-4e56-b913-3e1c1f643a7f",
      "amount": 13.00,
      "status": "DONE",
      "externalStatus": "SUCCESS",
      "category": "Transferência enviada",
      "beneficiaryName": "Loja Azul Celulares",
      "type": "TEF",
      "credit": false,
      "createdAt": "2025-10-06T22:31:09.000Z"
    },
    {
      "id": "e10aef72-2b0e-41e3-937a-b24e6ed6822d",
      "amount": 0.80,
      "status": "DONE",
      "externalStatus": "SUCCESS",
      "category": "Tarifa Pix",
      "beneficiaryName": "Banco Stric Global",
      "type": "FEE",
      "credit": false,
      "createdAt": "2025-10-06T22:28:13.000Z"
    },
    {
      "id": "c3ad2fa9-8a2f-4a14-8a93-8bda99a33a77",
      "amount": 75.00,
      "status": "DONE",
      "externalStatus": "SUCCESS",
      "category": "Pix enviado",
      "beneficiaryName": "Leonardo Tavares",
      "type": "PIX",
      "credit": false,
      "createdAt": "2025-10-06T21:47:55.000Z"
    },
    {
      "id": "0e01933d-3f2d-4f2f-8f40-1ac1f8138f6d",
      "amount": 5.00,
      "status": "DONE",
      "externalStatus": "SUCCESS",
      "category": "QR Code pago",
      "beneficiaryName": "Padaria São João",
      "type": "PIX_QRCODE",
      "credit": false,
      "createdAt": "2025-10-06T19:15:09.000Z"
    },
    {
      "id": "6de14f7e-7446-47b8-9b47-00a82b9cbfd9",
      "amount": 60.00,
      "status": "DONE",
      "externalStatus": "SUCCESS",
      "category": "Pix recebido",
      "beneficiaryName": "TechPlus Soluções Digitais",
      "type": "PIX",
      "credit": true,
      "createdAt": "2025-10-05T15:48:45.000Z"
    }
  ],
  "pagination": {
    "totalItems": 38,
    "currentPage": 0,
    "itemsPerPage": 20,
    "totalPages": 2
  }
}
Status
Descrição

PROCESSING

Transação em processamento

DONE

Transação processada e concluída

CANCELED

Transação cancelada

ERROR

Transação com erro

Last updated

Was this helpful?