Documentação das APIs

Consulta transações pelos critérios definidos

Este recurso possibilita a consulta das transações criadas dentro de um intervalo de datas específico, com a opção adicional de filtrar por tipo de pagamento e estado, se desejado.

Ao utilizar este método, é retornado um agrupamento das transações que correspondem aos filtros informados, fornecendo uma lista das transações que atendem aos critérios especificados.

Requisição

CampoTipoDescrição
DataHoraInicialDataData/hora inicial de consulta no padrão
DataHoraFinalDataData/hora final de consulta.
TipoTextoTipo da transação, podendo ser: “Boleto”, “Cartao” ou “Pix”. Campo opcional.
EstadoTextoEstado da transação, podendo ser: “Pendente”, “Aprovada”, “Rejeitada” ou “Cancelada”. Campo opcional.

Resposta

CampoTipoDescrição
RetornoTextoRetorno da chamada, podendo possuir os valores OK ou ERRO.
DetalhesErroTextoDetalhes do erro gerado, caso o retorno seja ERRO.
TransacoesTransacaoLista de transações retornadas pela consulta. Cada transação possui os seguintes campos:- Identificador: identificador da transação- Tipo: tipo da transação, podendo ser: “Boleto”, “Cartao” ou “Pix”.- Estado: estado da transação, podendo ser: “Pendente”, “Aprovada”, “Rejeitada” ou “Cancelada”.- MotivoCancelamento:Motivo de cancelamento da transação, caso tenha sido cancelada.- DataPagamento: Data/hora de pagamento da transação.- Valor: valor da transação.- ValorPago: valor pago da transação, pode ser menor (no caso de descontos) ou maior(no caso de juros) que o valor original solicitado.- ConfirmadaURL: indica se a transação foi confirmada na URL do comércio.- Splits: lista de “splits” relacionados a transação, indicando o código do cliente e o respectivo valor relacionado.- ClienteDescricao: descrição do cliente final da transação.- ClienteIP: IP do cliente final da transação.- ClienteCPFCNPJ: CPF/CNPJ do cliente final da transação.- ClienteNome: nome do cliente final da transação.
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!