v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

ConsultaTransacoes

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. <br />

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. <br />

Requisição

Campo	Tipo	Descrição	Obrigatório
DataHoraInicial	Data	Data/hora inicial de consulta	Sim
DataHoraFinal	Data	Data/hora final de consulta	Sim
Tipo	Texto	Tipo da transação	Sim
Estado	Texto	Estado da transação	Sim
TipoFiltro	Texto	Tipo do filtro para a consulta	Não

<br />

Resposta

Campo	Tipo	Descrição
Retorno	Texto	Retorno da chamada, podendo possuir os valores OK ou ERRO
DetalhesErro	Texto	Detalhes do erro gerado, caso o retorno seja ERRO
Transacoes	ConsultaTrasacaoResponse	-
Retorno	Texto	Retorno da chamada, podendo possuir os valores OK ou ERRO
DetalhesErro	Texto	Detalhes do erro gerado, caso o retorno seja ERRO
Identificador	Texto	Identificador da transação
Tipo	Texto	Tipo da forma de pagamento
Estado	Texto	Estado da transação
MotivoCancelamento	Texto	Motivo do cancelamento da compra
DataPagamento	Texto	Data do pagamento da transação
Valor	Número	Valor total da transação
ValorPago	Número	Valor pago da transação, pode ser menor (no caso de descontos) ou maior(no caso de juros) que o valor original solicitado
ConfirmaURL	Booleano	Indica se a transação foi confirmada na URL do comércio
Splits	TransacaoSplit	-
ClienteId	Texto	O Id do seller(ou do marketplace) que terá a decisão aprovada
Valor	Número	Valor da transação destinado ao Marketplace ou Seller
ValorRoyalties	Número	Valor 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
Decisao	Texto	Informa se o split será criado como auto aprovado
Parcelas	TransacaoParcela	-
Numero	Número	Número de parcelas
Estado	Texto	Estado da transação
MotivoCancelamento	Texto	Motivo do cancelamento da compra
DataPagamento	Texto	Data do pagamento da transação
Valor	Número	Valor total da transação
ConfirmaURL	Booleano	Indica se a transação foi confirmada na URL do comércio
ClienteDescricao	Texto	Descrição da compra
ClienteIP	Texto	IP do usuário final da compra
ClienteCPFCNPJ	Texto	CPF/CNPJ do cliente final da transação
NumeroPedido	Texto	Número do pedido e/ou carrinho de compras
CardToken	Texto	O token do cartão para transações de recorrência
Recorrente	Booleano	Retorna os valores true ou false, informando se esse pagamento é recorrente
ContaBolsao	Booleano	Retorna true ou false, para informar se os valores estão alocados em conta bolsão k8
Referencia	Texto	Referência para localização futura do boleto
DataLiquidacao	Texto	Data em que os valores da transação foram disponibilizados ao recebedor
DataDisponibilizacao	Texto	Data da disponibilização do valor ao recebedor
Liquidacao	Booleano	Retorna se foi realizada a liquidação da transação
EndToEnd	Texto	Exclusivos para transação do tipo pix, retornando o end to end da transação

post/api/ConsultaTransacoes

Headers

Aeskeystring required

Request body

DataHoraInicialstring date-time

DataHoraFinalstring date-time

TipoFiltro'dataemissao' | 'datapagamento' | 'checkout'

Example request

{
  "DataHoraInicial": "2026-05-06T09:47:50.9680678-03:00",
  "DataHoraFinal": "2026-05-21T09:47:50.9680678-03:00",
  "Tipo": "Todos",
  "Estado": "Aprovada",
  "TipoFiltro": "dataemissao"
}

Response

Método executado com sucesso

Retorno'OK' | 'ERRO'

DetalhesErrostring

Example response

{
  "Transacoes": [
    {
      "Splits": [
        {
          "ClienteId": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "CardToken": "00000000-0000-0000-0000-000000000000"
    }
  ]
}