Consulta de extrato

Request

ENDPOINT

/account_statement

MÉTODO

GET

PARÂMETROS

account_key, document_number, date_from, date_to, page, page_size

QUERY PARAMS

Campo	Tipo	Descrição	Máx. de caracteres	Exemplo
account_key *	string	Chave uuid da conta.	chave uuid
date_from *	date	Data de início do intervalo consultado.	10	2023-10-10
date_to *	date	Data final do intervalo consultado.	10	2023-10-10
page	string	Índice da página retornado	2	1
page_size	string	Quantidade de transações a ser retornada (Máximo 4000)	4	3999
order_by	string	Data final do intervalo consultado.	3	asc

Response

STATUS

200

Response Body

{
  "data": {
    "account_info": {
      "account_block_reason": null,
      "account_branch": "0001",
      "account_credentials": [],
      "account_digit": "0",
      "account_key": "22189d43-4503-47c6-a05b-be29a534b2ac",
      "account_name": "Default",
      "account_number": "1467576",
      "account_status": "opened",
      "account_type": "checking",
      "automatic_transfers": [],
      "balance": 88637.41,
      "blocked_balance": 0,
      "destinations": [],
      "fee": 0.1,
      "internal_webhooks": [],
      "owner_document_number": "555555555",
      "owner_name": "Teste da Silva Testado",
      "owner_person_key": "f580d89d-217c-4244-ac88-5f4ec6861a5e",
      "permitted_person_keys": [
        "f580d89d-217c-4244-ac88-5f4ec6861a5e"
      ],
      "requester_key": "f580d89d-217c-4244-ac88-5f4ec6861a5e",
      "requester_name": "Teste da Silva Testado",
      "setup_fee": null,
      "transactional_limit": null,
      "webhook_enabled": true
    },
    "transaction_list": [
      {
        "account_balance": 88637.41,
        "description": "JORGE DA SILVA TESTE - 555555555",
        "source_subtype": "bank_slip_payment",
        "transacted_at": "2022-06-22 15:39:39",
        "transaction_amount": -1.5,
        "transaction_key": "D2Bb0f4e-cbb6-4f6a-8ea6-b66710d3dde8"
      },
      {
        "account_balance": 88638.91,
        "description": " 0001 52260-6 01.871.112/0001-80 ",
        "source_subtype": "pix_withdrawal_reversal",
        "transacted_at": "2022-06-20 19:28:16",
        "transaction_amount": 0.72,
        "transaction_key": "55c68b62-0288-4481-a6c2-44e9386e5d3f"
      }
    ]
  },
  "event_datetime": "2022-06-23 16:21:15",
  "key": "000fa133-2f45-4c39-ae76-c87cccb2c034",
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "rows_per_page": 10,
    "total_pages": "unavailable",
    "total_rows": null
  },
  "status": "success",
  "webhook_type": "account_statement"
}

Dica de Paginação

O page_size é o indicador da quantidade de transações.

Se o número de transações retornadas é igual ao page_size informado, podem existir mais transações e a próxima página deve ser consultada.

Caso o número de itens contidos na lista "transaction_list" seja menor que o page_size ou igual zero, significa que não existem mais resultados e a página atual é a última da listagem.

STATUS

400

Response Body

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}