v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBConsulta 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
Número da conta.
CPF do operador.
Data de início do filtro no formato YYYY-MM-DD.
Data final do filtro no formato YYYY-MM-DD.
Tipo de movimentação, sendo entrada ou saida.
Filtro por origem movimento, manual, qrcode, chave, devolucao, inic_pag, inic_pag_manu, inic_pag_qrcode e inic_pag_chave
Filtro por beneficiario
Página do filtro, padrão 1
Registros por página, padrão 10
Headers
Client ID enviado no Header
Response
Sucesso na consulta.
Example response
{
"message": "Extrato Pix."
}