---
title: "Consulta transações pelos critérios definidos"
method: POST
path: "/api/ConsultaTransacoes"
tags: ["ConsultaTransacoes"]
---

# Consulta transações pelos critérios definidos

`POST /api/ConsultaTransacoes`

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 |

## Headers

- `Aeskey` string, required

## Request body

- BknBankPagamentosBusinessConsultaTransacoesRequest
  - `DataHoraInicial` string, date-time
  - `DataHoraFinal` string, date-time
  - `Tipo` 'Todos' | 'NaoDefinido' | 'Boleto' | 'Cartao' | 'Pix' | 'Ted' | 'SaldoWebConta' | 'BoletoHibrido' | 'OpenFinance' | 'Manual'
  - `Estado` 'Todos' | 'Pendente' | 'Aprovada' | 'Rejeitada' | 'Cancelada' | 'ACancelar' | 'pendenteCobranca' | 'acancelarCNAB' | 'PendenteAntifraude' | 'AnaliseAntifraude' | 'ProcessarInstrucao' | 'EmProcessamento' | 'PagoeAberto' | 'EstornarPIX' | 'Estornado' | 'ErroEstorno' | 'Liquidado' | 'FalhaCancelamento' | 'CartaoPreAutorizado' | 'CartaoCancelametoFuturo' | 'ErroGerarPixBH'
  - `TipoFiltro` 'dataemissao' | 'datapagamento' | 'checkout'

## Response `200`

Método executado com sucesso

- BknBankPagamentosBusinessConsultaTransacoesResponse
  - `Retorno` 'OK' | 'ERRO'
  - `DetalhesErro` string
  - `Transacoes` BknBankPagamentosBusinessConsultaTransacaoResponse[]
    - `Retorno` 'OK' | 'ERRO'
    - `DetalhesErro` string
    - `Identificador` string
    - `Tipo` 'Todos' | 'NaoDefinido' | 'Boleto' | 'Cartao' | 'Pix' | 'Ted' | 'SaldoWebConta' | 'BoletoHibrido' | 'OpenFinance' | 'Manual'
    - `Estado` 'Todos' | 'Pendente' | 'Aprovada' | 'Rejeitada' | 'Cancelada' | 'ACancelar' | 'pendenteCobranca' | 'acancelarCNAB' | 'PendenteAntifraude' | 'AnaliseAntifraude' | 'ProcessarInstrucao' | 'EmProcessamento' | 'PagoeAberto' | 'EstornarPIX' | 'Estornado' | 'ErroEstorno' | 'Liquidado' | 'FalhaCancelamento' | 'CartaoPreAutorizado' | 'CartaoCancelametoFuturo' | 'ErroGerarPixBH'
    - `TipoPagamento` 'todos' | 'naodefinido' | 'boleto' | 'cartao' | 'pix' | 'ted' | 'SaldoWebConta' | 'OpenFinance' | 'Manual'
    - `MotivoCancelamento` string
    - `DataPagamento` string, date-time
    - `Valor` number, double
    - `ValorPago` number, double
    - `ValorTaxas` number, double
    - `DetalhesValores` BknBankPagamentosBusinessDetalhesValores
      - `ValorDesconto` number, double
      - `ValorDesconto2` number, double
      - `ValorDesconto3` number, double
      - `ValorMulta` number, double
      - `ValorJuros` number, double
    - `ConfirmadaURL` boolean
    - `Splits` BknBankPagamentosBusinessTransacaoSplit[]
      - `ClienteId` string, uuid
      - `Valor` number, double
      - `ValorRoyalties` number, double
      - `Decisao` string
    - `Parcelas` BknBankPagamentosBusinessTransacaoParcela[]
      - `Numero` integer
      - `Estado` 'Todos' | 'Pendente' | 'Aprovada' | 'Rejeitada' | 'Cancelada' | 'ACancelar' | 'pendenteCobranca' | 'acancelarCNAB' | 'PendenteAntifraude' | 'AnaliseAntifraude' | 'ProcessarInstrucao' | 'EmProcessamento' | 'PagoeAberto' | 'EstornarPIX' | 'Estornado' | 'ErroEstorno' | 'Liquidado' | 'FalhaCancelamento' | 'CartaoPreAutorizado' | 'CartaoCancelametoFuturo' | 'ErroGerarPixBH'
      - `MotivoCancelamento` string
      - `DataPagamento` string, date-time
      - `Valor` number, double
      - `ConfirmadaURL` boolean
    - `ClienteDescricao` string
    - `ClienteIP` string
    - `ClienteCPFCNPJ` string
    - `ClienteNome` string
    - `NumeroPedido` string
    - `CardToken` string, uuid
    - `Recorrente` boolean
    - `ContaBolsao` boolean
    - `Referencia` string
    - `DataLiquidacao` string, date-time
    - `DataDisponibilizacao` string, date-time
    - `Liquidado` boolean
    - `EndToEnd` string
    - `LinhaDigitavel` string
    - `CodigoBarras` string
    - `NossoNumero` string
    - `QRCodeTexto` string
    - `CanalPagamento` 'NaoDefinido' | 'AgenciasPostosTradicionais' | 'TerminalAutoAtendimento' | 'Internet' | 'Pix' | 'CorrespondenteBancario' | 'CentralAtendimento' | 'ArquivoEletronico' | 'DDA' | 'CorrespondenteBancarioDigital'
    - `MeioPagamento` 'NaoDefinido' | 'Especie' | 'DebitoEmConta' | 'CartaoCredito' | 'Cheque'
    - `ContaEmissao` string

## Other responses

- `500` — Erro executando método

---

[API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/revisions/14db4977f490/schema)