Sign in

v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Extrato

Exportar extrato pix

Pagamento - Exportar Extrato Pix<br/>Permite ao usuário exportar a consulta do extrato PIX de movimentações<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>type</td><td>Texto</td><td>Tipo de export, sendo pdf ou csv.</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 filtro, sendo: entrada ou saida</td><td>Não</td></tr><tr><td>origemMovimento</td><td>Texto</td><td>Origem do movimento, sendo: 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>Nome do recebedor.</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>receipt</td><td>Conteúdo</td><td>Código Base 64 do relatório exportado</td></tr></tbody></table>

get/api/v1/balance/extrato-pix-export

Query parameters

contaOrigemstring required
Example:0000000000

Número da conta.

cpfOperadorstring required
Example:00000000000

CPF do operador.

payment_date_startstring required
Example:2025-10-13

Data de início do filtro no formato YYYY-MM-DD.

payment_date_endstring required
Example:2025-10-13

Data final do filtro no formato YYYY-MM-DD.

naturezastring
Example:entrada ou saida

Tipo de movimentação, sendo entrada ou saida.

origemMovimentostring
Example:manual, qrcode, chave, devolucao, inic_pag, inic_pag_manu, inic_pag_qrcode e inic_pag_chave

Filtro por origem movimento, manual, qrcode, chave, devolucao, inic_pag, inic_pag_manu, inic_pag_qrcode e inic_pag_chave

receiverstring
Example:João José

Filtro por beneficiario

typestring
Example:pdf ou csv

Formato de saída da exportação.

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Response

Sucesso na consulta.

messagestring

Example response

{
  "message": "Exportar Extrato Pix.",
  "data": [
    {
      "receipt": "base64"
    }
  ]
}