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çãoObrigatório
DataHoraInicialDataData/hora inicial de consultaSim
DataHoraFinalDataData/hora final de consultaSim
TipoTextoTipo da transaçãoSim
EstadoTextoEstado da transaçãoSim
TipoFiltroTextoTipo do filtro para a consultaNão

Resposta

CampoTipoDescrição
RetornoTextoRetorno da chamada, podendo possuir os valores OK ou ERRO
DetalhesErroTextoDetalhes do erro gerado, caso o retorno seja ERRO
TransacoesConsultaTrasacaoResponse-
RetornoTextoRetorno da chamada, podendo possuir os valores OK ou ERRO
DetalhesErroTextoDetalhes do erro gerado, caso o retorno seja ERRO
IdentificadorTextoIdentificador da transação
TipoTextoTipo da forma de pagamento
EstadoTextoEstado da transação
MotivoCancelamentoTextoMotivo do cancelamento da compra
DataPagamentoTextoData do pagamento da transação
ValorNúmeroValor total da transação
ValorPagoNúmeroValor pago da transação, pode ser menor (no caso de descontos) ou maior(no caso de juros) que o valor original solicitado
ConfirmaURLBooleanoIndica se a transação foi confirmada na URL do comércio
SplitsTransacaoSplit-
ClienteIdTextoO Id do seller(ou do marketplace) que terá a decisão aprovada
ValorNúmeroValor da transação destinado ao Marketplace ou Seller
ValorRoyaltiesNúmeroValor da transação destinado ao Marketplace ou Seller, sobre o qual poderão incidir taxas, conforme a configuração prévia definida para o participante do split
DecisaoTextoInforma se o split será criado como auto aprovado
ParcelasTransacaoParcela-
NumeroNúmeroNúmero de parcelas
EstadoTextoEstado da transação
MotivoCancelamentoTextoMotivo do cancelamento da compra
DataPagamentoTextoData do pagamento da transação
ValorNúmeroValor total da transação
ConfirmaURLBooleanoIndica se a transação foi confirmada na URL do comércio
ClienteDescricaoTextoDescrição da compra
ClienteIPTextoIP do usuário final da compra
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação
NumeroPedidoTextoNúmero do pedido e/ou carrinho de compras
CardTokenTextoO token do cartão para transações de recorrência
RecorrenteBooleanoRetorna os valores true ou false, informando se esse pagamento é recorrente
ContaBolsaoBooleanoRetorna true ou false, para informar se os valores estão alocados em conta bolsão k8
ReferenciaTextoReferência para localização futura do boleto
DataLiquidacaoTextoData em que os valores da transação foram disponibilizados ao recebedor
DataDisponibilizacaoTextoData da disponibilização do valor ao recebedor
LiquidacaoBooleanoRetorna se foi realizada a liquidação da transação
EndToEndTextoExclusivos para transação do tipo pix, retornando o end to end da transação
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!