Listar histórico de documentos

Tem como objetivo listar os documentos disponíveis do CPF de uma determinada emissora em um intervalo de tempo especificado pelo usuário.

info

Para confidencialidade das informações, campos sensíveis são retornados criptografados utilizando o padrão JWE (JSON Web Encryption).

Interface

Método HTTP	Endpoint
GET	https://api.ez-pay.app/v1/list_invoices_history

Parâmetros de entrada

Header
Bearer token

Query Params
Parâmetro	Tipo
id_emissora	STRING(36) ID da empresa qual deseja o documento, a ser informado
cpf	STRING(11) CPF do cliente que deseja receber os documentos
min_due_date	STRING(10) Data mínima de vencimento do documento no formato 'AAAA-MM-DD'
max_due_date	STRING(10) Data máxima de vencimento do documento no formato 'AAAA-MM-DD'

Exemplo
Key	Value
id_emissora	emissoraaemissoraaemissoraaemissoraa
cpf	40732223091
min_due_date	2023-01-01
max_due_date	2024-03-01

Response

{
    "data": [
        {
            "id_documento": "42e2367c2ecf528037a717bed494fa1b",
            "contrato": "",
            "cpf": "eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..vneB3agGM04lVgJWhhKCPw.IFPQYuudJd0dJ2Q.9bZn-asNr4Zo49h61Ery5g",
            "linha_digitavel": "eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..iZH78UCfFPX90ifgRLU6Zw.PTe9xrDgNoODob4X9B624P6ijwgEREMVbjjeECFidhm1W23m9oeARACcgW-mLHLI._T4iqglpdZuiuSDC2GbiwQ",
            "pix": "eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..471iWLsSrvXDA7r0AS4eQA.G0thYqO8gt3QzlKaPOiZsp-_02jOxccGXwXC_zAMlPj0tLGY5u0RlgV4RCRg-WmeJeU63353L3ZJ74gxCAhNlFDDdbq-XJsHHRx2lKD8_v6EOaKnkYj9KGAVhJPsKQowxnBXWjjfNLHjHAatgjzClbzGZjwae8FXPdqN2nBQN-4bJQs6ixqLkJ9O9q1jmTfFL9sJiHD8jUqLnir4mEBQrHSWYhrya3DDU7BhD_7z4gf9KDvX0Cftpn4B_3N47Vv6oB30JSBgbpc.IZOJg6SS01WL4k-L5wcGOg",
            "preferencia_pgto": "pix",
            "nome_cliente": "",
            "nome_produto": "",
            "referencia": "",
            "valor": "100,00",
            "vencimento": "2024-10-28",
            "id_emissora": "74619dfc-9071-4b0c-9c06-39c53d84e882",
            "cnpj_emissora": "12345678912345",
            "logotipo_emissora": "https://logotipo.com/public/logos/imagem.png",
            "nome_emissora": "Empresa Emissora A",
            "segmento": "Telefonia Móvel"
        }
    ],
    "message": "Requisição processada com sucesso",
    "trackid": "bc47bb3f-e051-4540-a565-10a935799758"
}

Mensagens

Código HTTP	Mensagem
200	Requisição processada com sucesso
200	Nenhum documento encontrado
204	CPF não possui opt-in
400	Parâmetros inválidos
400	CPF inválido
401	Credential unexpected
500	Erro ao processar a requisição