# Listar transações

Esta seção tem como objetivo detalhar a obtenção de uma lista de transações.

# Requisição

Query string params

# cpf Number Opcional
Permite buscar por um cpf, informar apenas numeros.
Exemplo: cpf=00011122233
# _limit Number Opcional
Quantidade máxima de registros retornados na resposta.
Valor máximo (padrão): _limit=10
# _order String Opcional
Ordenar os registros por data de criação de forma crescente ou decrescente.
Decrescente (Padrão): _order=desc
Crescente: _order=asc
# _reports String Opcional
Permite buscar por um ou mais relatórios separando os valores pelo caractere pipe |.
Exemplo: _reports=report1|report2|report3
# _templates String Opcional
Permite buscar por um ou mais modelos de consulta separando os valores pelo caractere pipe |.
Exemplo: _templates=template1|template2|template3
# _startCreatedDate String - ("YYYY-MM-DD") Opcional
Permite definir o dia inicial em que os registros foram criados.
Obter registros criados a partir de 30 de janeiro de 2022: _startCreatedDate=2022-01-30

Importante: A data mais antiga possível para consultas retroativas é de 3 dias a contar da data atual.

# _endCreatedDate String - ("YYYY-MM-DD") Opcional
Permite definir a data máxima em que os registros foram criados.
Obter registros criados até 31 de janeiro de 2022: _startCreatedDate=2022-01-31

# Resposta

# requestId String
Identificador único da requisição realizada.
# items Array of objects

Um array contendo as transações encontradas conforme os filtros aplicados

Atributos de items

# id String

Identificador único da transação.

# status String

Indica o status em que a transação se encontra, sendo: APPROVED, REPROVED, PENDING, PENDING_OCR ou PROCESSING.

# createdAt String

Indica a data de criação da transação.

# data Object

Atributos de data

# cpf String

Número de registro de pessoa física

# name String

Nome do registro.

# birthDate String

Data de nascimento

# cnpj String

Número de registro de pessoa jurídica
# totalItems Number
Indica o total de items que correspondem ao filtro na base.