---
title: "Consulta extrato pix"
method: GET
path: "/api/v1/balance/extrato-pix"
tags: ["Extrato"]
---

# Consulta extrato pix

`GET /api/v1/balance/extrato-pix`

**Pagamento - Extrato Pix**<br/>Permite ao usuário consultar o extrato de movimentações PIX<br/><br/>**Requisição**<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>cpfOperador</td><td>Texto</td><td>CPF do recebedor</td><td>Sim</td></tr><tr><td>contaOrigem</td><td>Texto</td><td>Conta da qual se origina o pagamento com o digito verificador.</td><td>Sim</td></tr><tr><td>payment_date_start</td><td>Texto</td><td>Data de início do filtro no formato YYYY-MM-DD</td><td>Sim</td></tr><tr><td>payment_date_end</td><td>Texto</td><td>Data final do filtro no formato YYYY-MM-DD</td><td>Sim</td></tr><tr><td>natureza</td><td>Texto</td><td>Tipo de movimentação, sendo entrada ou saida.</td><td>Não</td></tr><tr><td>origemMovimento</td><td>Texto</td><td>Filtro por origem movimento, manual, qrcode, chave, devolucao, inic_pag, inic_pag_manu, inic_pag_qrcode e inic_pag_chave</td><td>Não</td></tr><tr><td>receiver</td><td>Texto</td><td>Filtro por beneficiario</td><td>Não</td></tr><tr><td>page</td><td>Texto</td><td>Página do filtro, padrão 1</td><td>Não</td></tr><tr><td>per_page</td><td>Texto</td><td>Registros por página, padrão 10</td><td>Não</td></tr></tbody></table><br><br>**Resposta**<br><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>list</td><td>Lista</td><td>Listegem de transações</td></tr><tr><td>total_entries</td><td>Numérico</td><td>Total de resultados</td></tr><tr><td>total_pages</td><td>Numérico</td><td>Total de páginas</td></tr></tbody></table>

## Query parameters

- `contaOrigem` string, required
- `cpfOperador` string, required
- `payment_date_start` string, required
- `payment_date_end` string, required
- `natureza` string
- `origemMovimento` string
- `receiver` string
- `page` string
- `per_page` string

## Headers

- `client-id` string, uuid, required

## Response `200`

Sucesso na consulta.

- object
  - `message` string
  - `data` object[]
    - `total_entries` integer
    - `total_pages` integer
    - `list` object[]
      - `chave` string
      - `cod_agencia` string
      - `cod_agencia_lancamento` string
      - `cod_ispb` string
      - `cod_ispb_lancamento` string
      - `cpf_cnpj` string
      - `cpf_cnpj_contra_parte` string
      - `data_hora_solicitacao` string
      - `data_movimento` string
      - `descricao` string
      - `devolucao_amount` string
      - `devolucao_date` string
      - `devolucao_receipt_exist` boolean
      - `end_to_end` string
      - `end_to_end_original` string
      - `finalidade_da_transacao` string
      - `ind_devolucao` boolean
      - `ind_elegivel_devolucao` boolean
      - `internal_devolucao_exist` boolean
      - `internal_devolucao_id` string
      - `internal_devolucao_link` string
      - `is_pix_automatic` boolean
      - `natureza` string
      - `nome` string
      - `nome_instituicao` string
      - `nome_instituicao_lancamento` string
      - `nro_conta` string
      - `nro_conta_lancamento` string
      - `nro_movimento` string
      - `origem_movimento` string
      - `valor` number, float
      - `valor_devolucao` number, float

## Other responses

- `401` — Invalid client data.
- `403` — Invalid token.
- `422` — Invalid input fields.

---

[API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/revisions/14db4977f490/schema)